diff --git a/docs/dyn/accesscontextmanager_v1.accessPolicies.servicePerimeters.html b/docs/dyn/accesscontextmanager_v1.accessPolicies.servicePerimeters.html index c4034a2160..a83213aa2b 100644 --- a/docs/dyn/accesscontextmanager_v1.accessPolicies.servicePerimeters.html +++ b/docs/dyn/accesscontextmanager_v1.accessPolicies.servicePerimeters.html @@ -173,7 +173,7 @@

Method Details

"egressPolicies": [ # List of EgressPolicies to apply to the perimeter. A perimeter may have multiple EgressPolicies, each of which is evaluated separately. Access is granted if any EgressPolicy grants it. Must be empty for a perimeter bridge. { # Policy for egress from perimeter. EgressPolicies match requests based on `egress_from` and `egress_to` stanzas. For an EgressPolicy to match, both `egress_from` and `egress_to` stanzas must be matched. If an EgressPolicy matches a request, the request is allowed to span the ServicePerimeter boundary. For example, an EgressPolicy can be used to allow VMs on networks within the ServicePerimeter to access a defined set of projects outside the perimeter in certain contexts (e.g. to read data from a Cloud Storage bucket or query against a BigQuery dataset). EgressPolicies are concerned with the *resources* that a request relates as well as the API services and API actions being used. They do not related to the direction of data movement. More detailed documentation for this concept can be found in the descriptions of EgressFrom and EgressTo. "egressFrom": { # Defines the conditions under which an EgressPolicy matches a request. Conditions based on information about the source of the request. Note that if the destination of the request is also protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed. # Defines conditions on the source of a request causing this EgressPolicy to apply. - "identities": [ # A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. + "identities": [ # A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, third-party identity, or agent identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access to outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. @@ -213,7 +213,7 @@

Method Details

"ingressPolicies": [ # List of IngressPolicies to apply to the perimeter. A perimeter may have multiple IngressPolicies, each of which is evaluated separately. Access is granted if any Ingress Policy grants it. Must be empty for a perimeter bridge. { # Policy for ingress into ServicePerimeter. IngressPolicies match requests based on `ingress_from` and `ingress_to` stanzas. For an ingress policy to match, both the `ingress_from` and `ingress_to` stanzas must be matched. If an IngressPolicy matches a request, the request is allowed through the perimeter boundary from outside the perimeter. For example, access from the internet can be allowed either based on an AccessLevel or, for traffic hosted on Google Cloud, the project of the source network. For access from private networks, using the project of the hosting network is required. Individual ingress policies can be limited by restricting which services and/or actions they match using the `ingress_to` field. "ingressFrom": { # Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request. The request must satisfy what is defined in `sources` AND identity related fields in order to match. # Defines the conditions on the source of a request causing this IngressPolicy to apply. - "identities": [ # A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. + "identities": [ # A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, third-party identity, or agent identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access from outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. @@ -266,7 +266,7 @@

Method Details

"egressPolicies": [ # List of EgressPolicies to apply to the perimeter. A perimeter may have multiple EgressPolicies, each of which is evaluated separately. Access is granted if any EgressPolicy grants it. Must be empty for a perimeter bridge. { # Policy for egress from perimeter. EgressPolicies match requests based on `egress_from` and `egress_to` stanzas. For an EgressPolicy to match, both `egress_from` and `egress_to` stanzas must be matched. If an EgressPolicy matches a request, the request is allowed to span the ServicePerimeter boundary. For example, an EgressPolicy can be used to allow VMs on networks within the ServicePerimeter to access a defined set of projects outside the perimeter in certain contexts (e.g. to read data from a Cloud Storage bucket or query against a BigQuery dataset). EgressPolicies are concerned with the *resources* that a request relates as well as the API services and API actions being used. They do not related to the direction of data movement. More detailed documentation for this concept can be found in the descriptions of EgressFrom and EgressTo. "egressFrom": { # Defines the conditions under which an EgressPolicy matches a request. Conditions based on information about the source of the request. Note that if the destination of the request is also protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed. # Defines conditions on the source of a request causing this EgressPolicy to apply. - "identities": [ # A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. + "identities": [ # A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, third-party identity, or agent identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access to outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. @@ -306,7 +306,7 @@

Method Details

"ingressPolicies": [ # List of IngressPolicies to apply to the perimeter. A perimeter may have multiple IngressPolicies, each of which is evaluated separately. Access is granted if any Ingress Policy grants it. Must be empty for a perimeter bridge. { # Policy for ingress into ServicePerimeter. IngressPolicies match requests based on `ingress_from` and `ingress_to` stanzas. For an ingress policy to match, both the `ingress_from` and `ingress_to` stanzas must be matched. If an IngressPolicy matches a request, the request is allowed through the perimeter boundary from outside the perimeter. For example, access from the internet can be allowed either based on an AccessLevel or, for traffic hosted on Google Cloud, the project of the source network. For access from private networks, using the project of the hosting network is required. Individual ingress policies can be limited by restricting which services and/or actions they match using the `ingress_to` field. "ingressFrom": { # Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request. The request must satisfy what is defined in `sources` AND identity related fields in order to match. # Defines the conditions on the source of a request causing this IngressPolicy to apply. - "identities": [ # A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. + "identities": [ # A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, third-party identity, or agent identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access from outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. @@ -446,7 +446,7 @@

Method Details

"egressPolicies": [ # List of EgressPolicies to apply to the perimeter. A perimeter may have multiple EgressPolicies, each of which is evaluated separately. Access is granted if any EgressPolicy grants it. Must be empty for a perimeter bridge. { # Policy for egress from perimeter. EgressPolicies match requests based on `egress_from` and `egress_to` stanzas. For an EgressPolicy to match, both `egress_from` and `egress_to` stanzas must be matched. If an EgressPolicy matches a request, the request is allowed to span the ServicePerimeter boundary. For example, an EgressPolicy can be used to allow VMs on networks within the ServicePerimeter to access a defined set of projects outside the perimeter in certain contexts (e.g. to read data from a Cloud Storage bucket or query against a BigQuery dataset). EgressPolicies are concerned with the *resources* that a request relates as well as the API services and API actions being used. They do not related to the direction of data movement. More detailed documentation for this concept can be found in the descriptions of EgressFrom and EgressTo. "egressFrom": { # Defines the conditions under which an EgressPolicy matches a request. Conditions based on information about the source of the request. Note that if the destination of the request is also protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed. # Defines conditions on the source of a request causing this EgressPolicy to apply. - "identities": [ # A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. + "identities": [ # A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, third-party identity, or agent identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access to outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. @@ -486,7 +486,7 @@

Method Details

"ingressPolicies": [ # List of IngressPolicies to apply to the perimeter. A perimeter may have multiple IngressPolicies, each of which is evaluated separately. Access is granted if any Ingress Policy grants it. Must be empty for a perimeter bridge. { # Policy for ingress into ServicePerimeter. IngressPolicies match requests based on `ingress_from` and `ingress_to` stanzas. For an ingress policy to match, both the `ingress_from` and `ingress_to` stanzas must be matched. If an IngressPolicy matches a request, the request is allowed through the perimeter boundary from outside the perimeter. For example, access from the internet can be allowed either based on an AccessLevel or, for traffic hosted on Google Cloud, the project of the source network. For access from private networks, using the project of the hosting network is required. Individual ingress policies can be limited by restricting which services and/or actions they match using the `ingress_to` field. "ingressFrom": { # Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request. The request must satisfy what is defined in `sources` AND identity related fields in order to match. # Defines the conditions on the source of a request causing this IngressPolicy to apply. - "identities": [ # A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. + "identities": [ # A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, third-party identity, or agent identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access from outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. @@ -539,7 +539,7 @@

Method Details

"egressPolicies": [ # List of EgressPolicies to apply to the perimeter. A perimeter may have multiple EgressPolicies, each of which is evaluated separately. Access is granted if any EgressPolicy grants it. Must be empty for a perimeter bridge. { # Policy for egress from perimeter. EgressPolicies match requests based on `egress_from` and `egress_to` stanzas. For an EgressPolicy to match, both `egress_from` and `egress_to` stanzas must be matched. If an EgressPolicy matches a request, the request is allowed to span the ServicePerimeter boundary. For example, an EgressPolicy can be used to allow VMs on networks within the ServicePerimeter to access a defined set of projects outside the perimeter in certain contexts (e.g. to read data from a Cloud Storage bucket or query against a BigQuery dataset). EgressPolicies are concerned with the *resources* that a request relates as well as the API services and API actions being used. They do not related to the direction of data movement. More detailed documentation for this concept can be found in the descriptions of EgressFrom and EgressTo. "egressFrom": { # Defines the conditions under which an EgressPolicy matches a request. Conditions based on information about the source of the request. Note that if the destination of the request is also protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed. # Defines conditions on the source of a request causing this EgressPolicy to apply. - "identities": [ # A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. + "identities": [ # A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, third-party identity, or agent identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access to outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. @@ -579,7 +579,7 @@

Method Details

"ingressPolicies": [ # List of IngressPolicies to apply to the perimeter. A perimeter may have multiple IngressPolicies, each of which is evaluated separately. Access is granted if any Ingress Policy grants it. Must be empty for a perimeter bridge. { # Policy for ingress into ServicePerimeter. IngressPolicies match requests based on `ingress_from` and `ingress_to` stanzas. For an ingress policy to match, both the `ingress_from` and `ingress_to` stanzas must be matched. If an IngressPolicy matches a request, the request is allowed through the perimeter boundary from outside the perimeter. For example, access from the internet can be allowed either based on an AccessLevel or, for traffic hosted on Google Cloud, the project of the source network. For access from private networks, using the project of the hosting network is required. Individual ingress policies can be limited by restricting which services and/or actions they match using the `ingress_to` field. "ingressFrom": { # Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request. The request must satisfy what is defined in `sources` AND identity related fields in order to match. # Defines the conditions on the source of a request causing this IngressPolicy to apply. - "identities": [ # A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. + "identities": [ # A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, third-party identity, or agent identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access from outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. @@ -661,7 +661,7 @@

Method Details

"egressPolicies": [ # List of EgressPolicies to apply to the perimeter. A perimeter may have multiple EgressPolicies, each of which is evaluated separately. Access is granted if any EgressPolicy grants it. Must be empty for a perimeter bridge. { # Policy for egress from perimeter. EgressPolicies match requests based on `egress_from` and `egress_to` stanzas. For an EgressPolicy to match, both `egress_from` and `egress_to` stanzas must be matched. If an EgressPolicy matches a request, the request is allowed to span the ServicePerimeter boundary. For example, an EgressPolicy can be used to allow VMs on networks within the ServicePerimeter to access a defined set of projects outside the perimeter in certain contexts (e.g. to read data from a Cloud Storage bucket or query against a BigQuery dataset). EgressPolicies are concerned with the *resources* that a request relates as well as the API services and API actions being used. They do not related to the direction of data movement. More detailed documentation for this concept can be found in the descriptions of EgressFrom and EgressTo. "egressFrom": { # Defines the conditions under which an EgressPolicy matches a request. Conditions based on information about the source of the request. Note that if the destination of the request is also protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed. # Defines conditions on the source of a request causing this EgressPolicy to apply. - "identities": [ # A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. + "identities": [ # A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, third-party identity, or agent identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access to outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. @@ -701,7 +701,7 @@

Method Details

"ingressPolicies": [ # List of IngressPolicies to apply to the perimeter. A perimeter may have multiple IngressPolicies, each of which is evaluated separately. Access is granted if any Ingress Policy grants it. Must be empty for a perimeter bridge. { # Policy for ingress into ServicePerimeter. IngressPolicies match requests based on `ingress_from` and `ingress_to` stanzas. For an ingress policy to match, both the `ingress_from` and `ingress_to` stanzas must be matched. If an IngressPolicy matches a request, the request is allowed through the perimeter boundary from outside the perimeter. For example, access from the internet can be allowed either based on an AccessLevel or, for traffic hosted on Google Cloud, the project of the source network. For access from private networks, using the project of the hosting network is required. Individual ingress policies can be limited by restricting which services and/or actions they match using the `ingress_to` field. "ingressFrom": { # Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request. The request must satisfy what is defined in `sources` AND identity related fields in order to match. # Defines the conditions on the source of a request causing this IngressPolicy to apply. - "identities": [ # A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. + "identities": [ # A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, third-party identity, or agent identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access from outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. @@ -754,7 +754,7 @@

Method Details

"egressPolicies": [ # List of EgressPolicies to apply to the perimeter. A perimeter may have multiple EgressPolicies, each of which is evaluated separately. Access is granted if any EgressPolicy grants it. Must be empty for a perimeter bridge. { # Policy for egress from perimeter. EgressPolicies match requests based on `egress_from` and `egress_to` stanzas. For an EgressPolicy to match, both `egress_from` and `egress_to` stanzas must be matched. If an EgressPolicy matches a request, the request is allowed to span the ServicePerimeter boundary. For example, an EgressPolicy can be used to allow VMs on networks within the ServicePerimeter to access a defined set of projects outside the perimeter in certain contexts (e.g. to read data from a Cloud Storage bucket or query against a BigQuery dataset). EgressPolicies are concerned with the *resources* that a request relates as well as the API services and API actions being used. They do not related to the direction of data movement. More detailed documentation for this concept can be found in the descriptions of EgressFrom and EgressTo. "egressFrom": { # Defines the conditions under which an EgressPolicy matches a request. Conditions based on information about the source of the request. Note that if the destination of the request is also protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed. # Defines conditions on the source of a request causing this EgressPolicy to apply. - "identities": [ # A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. + "identities": [ # A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, third-party identity, or agent identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access to outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. @@ -794,7 +794,7 @@

Method Details

"ingressPolicies": [ # List of IngressPolicies to apply to the perimeter. A perimeter may have multiple IngressPolicies, each of which is evaluated separately. Access is granted if any Ingress Policy grants it. Must be empty for a perimeter bridge. { # Policy for ingress into ServicePerimeter. IngressPolicies match requests based on `ingress_from` and `ingress_to` stanzas. For an ingress policy to match, both the `ingress_from` and `ingress_to` stanzas must be matched. If an IngressPolicy matches a request, the request is allowed through the perimeter boundary from outside the perimeter. For example, access from the internet can be allowed either based on an AccessLevel or, for traffic hosted on Google Cloud, the project of the source network. For access from private networks, using the project of the hosting network is required. Individual ingress policies can be limited by restricting which services and/or actions they match using the `ingress_to` field. "ingressFrom": { # Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request. The request must satisfy what is defined in `sources` AND identity related fields in order to match. # Defines the conditions on the source of a request causing this IngressPolicy to apply. - "identities": [ # A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. + "identities": [ # A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, third-party identity, or agent identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access from outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. @@ -882,7 +882,7 @@

Method Details

"egressPolicies": [ # List of EgressPolicies to apply to the perimeter. A perimeter may have multiple EgressPolicies, each of which is evaluated separately. Access is granted if any EgressPolicy grants it. Must be empty for a perimeter bridge. { # Policy for egress from perimeter. EgressPolicies match requests based on `egress_from` and `egress_to` stanzas. For an EgressPolicy to match, both `egress_from` and `egress_to` stanzas must be matched. If an EgressPolicy matches a request, the request is allowed to span the ServicePerimeter boundary. For example, an EgressPolicy can be used to allow VMs on networks within the ServicePerimeter to access a defined set of projects outside the perimeter in certain contexts (e.g. to read data from a Cloud Storage bucket or query against a BigQuery dataset). EgressPolicies are concerned with the *resources* that a request relates as well as the API services and API actions being used. They do not related to the direction of data movement. More detailed documentation for this concept can be found in the descriptions of EgressFrom and EgressTo. "egressFrom": { # Defines the conditions under which an EgressPolicy matches a request. Conditions based on information about the source of the request. Note that if the destination of the request is also protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed. # Defines conditions on the source of a request causing this EgressPolicy to apply. - "identities": [ # A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. + "identities": [ # A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, third-party identity, or agent identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access to outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. @@ -922,7 +922,7 @@

Method Details

"ingressPolicies": [ # List of IngressPolicies to apply to the perimeter. A perimeter may have multiple IngressPolicies, each of which is evaluated separately. Access is granted if any Ingress Policy grants it. Must be empty for a perimeter bridge. { # Policy for ingress into ServicePerimeter. IngressPolicies match requests based on `ingress_from` and `ingress_to` stanzas. For an ingress policy to match, both the `ingress_from` and `ingress_to` stanzas must be matched. If an IngressPolicy matches a request, the request is allowed through the perimeter boundary from outside the perimeter. For example, access from the internet can be allowed either based on an AccessLevel or, for traffic hosted on Google Cloud, the project of the source network. For access from private networks, using the project of the hosting network is required. Individual ingress policies can be limited by restricting which services and/or actions they match using the `ingress_to` field. "ingressFrom": { # Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request. The request must satisfy what is defined in `sources` AND identity related fields in order to match. # Defines the conditions on the source of a request causing this IngressPolicy to apply. - "identities": [ # A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. + "identities": [ # A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, third-party identity, or agent identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access from outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. @@ -975,7 +975,7 @@

Method Details

"egressPolicies": [ # List of EgressPolicies to apply to the perimeter. A perimeter may have multiple EgressPolicies, each of which is evaluated separately. Access is granted if any EgressPolicy grants it. Must be empty for a perimeter bridge. { # Policy for egress from perimeter. EgressPolicies match requests based on `egress_from` and `egress_to` stanzas. For an EgressPolicy to match, both `egress_from` and `egress_to` stanzas must be matched. If an EgressPolicy matches a request, the request is allowed to span the ServicePerimeter boundary. For example, an EgressPolicy can be used to allow VMs on networks within the ServicePerimeter to access a defined set of projects outside the perimeter in certain contexts (e.g. to read data from a Cloud Storage bucket or query against a BigQuery dataset). EgressPolicies are concerned with the *resources* that a request relates as well as the API services and API actions being used. They do not related to the direction of data movement. More detailed documentation for this concept can be found in the descriptions of EgressFrom and EgressTo. "egressFrom": { # Defines the conditions under which an EgressPolicy matches a request. Conditions based on information about the source of the request. Note that if the destination of the request is also protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed. # Defines conditions on the source of a request causing this EgressPolicy to apply. - "identities": [ # A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. + "identities": [ # A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, third-party identity, or agent identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access to outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. @@ -1015,7 +1015,7 @@

Method Details

"ingressPolicies": [ # List of IngressPolicies to apply to the perimeter. A perimeter may have multiple IngressPolicies, each of which is evaluated separately. Access is granted if any Ingress Policy grants it. Must be empty for a perimeter bridge. { # Policy for ingress into ServicePerimeter. IngressPolicies match requests based on `ingress_from` and `ingress_to` stanzas. For an ingress policy to match, both the `ingress_from` and `ingress_to` stanzas must be matched. If an IngressPolicy matches a request, the request is allowed through the perimeter boundary from outside the perimeter. For example, access from the internet can be allowed either based on an AccessLevel or, for traffic hosted on Google Cloud, the project of the source network. For access from private networks, using the project of the hosting network is required. Individual ingress policies can be limited by restricting which services and/or actions they match using the `ingress_to` field. "ingressFrom": { # Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request. The request must satisfy what is defined in `sources` AND identity related fields in order to match. # Defines the conditions on the source of a request causing this IngressPolicy to apply. - "identities": [ # A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. + "identities": [ # A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, third-party identity, or agent identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access from outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. @@ -1119,7 +1119,7 @@

Method Details

"egressPolicies": [ # List of EgressPolicies to apply to the perimeter. A perimeter may have multiple EgressPolicies, each of which is evaluated separately. Access is granted if any EgressPolicy grants it. Must be empty for a perimeter bridge. { # Policy for egress from perimeter. EgressPolicies match requests based on `egress_from` and `egress_to` stanzas. For an EgressPolicy to match, both `egress_from` and `egress_to` stanzas must be matched. If an EgressPolicy matches a request, the request is allowed to span the ServicePerimeter boundary. For example, an EgressPolicy can be used to allow VMs on networks within the ServicePerimeter to access a defined set of projects outside the perimeter in certain contexts (e.g. to read data from a Cloud Storage bucket or query against a BigQuery dataset). EgressPolicies are concerned with the *resources* that a request relates as well as the API services and API actions being used. They do not related to the direction of data movement. More detailed documentation for this concept can be found in the descriptions of EgressFrom and EgressTo. "egressFrom": { # Defines the conditions under which an EgressPolicy matches a request. Conditions based on information about the source of the request. Note that if the destination of the request is also protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed. # Defines conditions on the source of a request causing this EgressPolicy to apply. - "identities": [ # A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. + "identities": [ # A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, third-party identity, or agent identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access to outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. @@ -1159,7 +1159,7 @@

Method Details

"ingressPolicies": [ # List of IngressPolicies to apply to the perimeter. A perimeter may have multiple IngressPolicies, each of which is evaluated separately. Access is granted if any Ingress Policy grants it. Must be empty for a perimeter bridge. { # Policy for ingress into ServicePerimeter. IngressPolicies match requests based on `ingress_from` and `ingress_to` stanzas. For an ingress policy to match, both the `ingress_from` and `ingress_to` stanzas must be matched. If an IngressPolicy matches a request, the request is allowed through the perimeter boundary from outside the perimeter. For example, access from the internet can be allowed either based on an AccessLevel or, for traffic hosted on Google Cloud, the project of the source network. For access from private networks, using the project of the hosting network is required. Individual ingress policies can be limited by restricting which services and/or actions they match using the `ingress_to` field. "ingressFrom": { # Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request. The request must satisfy what is defined in `sources` AND identity related fields in order to match. # Defines the conditions on the source of a request causing this IngressPolicy to apply. - "identities": [ # A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. + "identities": [ # A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, third-party identity, or agent identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access from outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. @@ -1212,7 +1212,7 @@

Method Details

"egressPolicies": [ # List of EgressPolicies to apply to the perimeter. A perimeter may have multiple EgressPolicies, each of which is evaluated separately. Access is granted if any EgressPolicy grants it. Must be empty for a perimeter bridge. { # Policy for egress from perimeter. EgressPolicies match requests based on `egress_from` and `egress_to` stanzas. For an EgressPolicy to match, both `egress_from` and `egress_to` stanzas must be matched. If an EgressPolicy matches a request, the request is allowed to span the ServicePerimeter boundary. For example, an EgressPolicy can be used to allow VMs on networks within the ServicePerimeter to access a defined set of projects outside the perimeter in certain contexts (e.g. to read data from a Cloud Storage bucket or query against a BigQuery dataset). EgressPolicies are concerned with the *resources* that a request relates as well as the API services and API actions being used. They do not related to the direction of data movement. More detailed documentation for this concept can be found in the descriptions of EgressFrom and EgressTo. "egressFrom": { # Defines the conditions under which an EgressPolicy matches a request. Conditions based on information about the source of the request. Note that if the destination of the request is also protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed. # Defines conditions on the source of a request causing this EgressPolicy to apply. - "identities": [ # A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. + "identities": [ # A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, third-party identity, or agent identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access to outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. @@ -1252,7 +1252,7 @@

Method Details

"ingressPolicies": [ # List of IngressPolicies to apply to the perimeter. A perimeter may have multiple IngressPolicies, each of which is evaluated separately. Access is granted if any Ingress Policy grants it. Must be empty for a perimeter bridge. { # Policy for ingress into ServicePerimeter. IngressPolicies match requests based on `ingress_from` and `ingress_to` stanzas. For an ingress policy to match, both the `ingress_from` and `ingress_to` stanzas must be matched. If an IngressPolicy matches a request, the request is allowed through the perimeter boundary from outside the perimeter. For example, access from the internet can be allowed either based on an AccessLevel or, for traffic hosted on Google Cloud, the project of the source network. For access from private networks, using the project of the hosting network is required. Individual ingress policies can be limited by restricting which services and/or actions they match using the `ingress_to` field. "ingressFrom": { # Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request. The request must satisfy what is defined in `sources` AND identity related fields in order to match. # Defines the conditions on the source of a request causing this IngressPolicy to apply. - "identities": [ # A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. + "identities": [ # A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, third-party identity, or agent identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access from outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. diff --git a/docs/dyn/agentregistry_v1alpha.projects.locations.agents.html b/docs/dyn/agentregistry_v1alpha.projects.locations.agents.html index 4687e4f496..b9cbe4f685 100644 --- a/docs/dyn/agentregistry_v1alpha.projects.locations.agents.html +++ b/docs/dyn/agentregistry_v1alpha.projects.locations.agents.html @@ -86,6 +86,12 @@

Instance Methods

list_next()

Retrieves the next page of results.

+

+ search(parent, body=None, x__xgafv=None)

+

Searches Agents in a given project and location.

+

+ search_next()

+

Retrieves the next page of results.

Method Details

close() @@ -241,4 +247,95 @@

Method Details

+
+ search(parent, body=None, x__xgafv=None) +
Searches Agents in a given project and location.
+
+Args:
+  parent: string, Required. Parent value for SearchAgentsRequest. Format: `projects/{project}/locations/{location}`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Message for searching Agents
+  "pageSize": 42, # Optional. The maximum number of search results to return per page. The page size is capped at `100`, even if a larger value is specified. A negative value will result in an `INVALID_ARGUMENT` error. If unspecified or set to `0`, a default value of `20` will be used. The server may return fewer results than requested.
+  "pageToken": "A String", # Optional. If present, retrieve the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of all other method parameters, must be identical to those in the previous call.
+  "searchString": "A String", # Optional. Search criteria used to select the Agents to return. If no search criteria is specified then all accessible Agents will be returned. Search expressions can be used to restrict results based upon searchable fields, where the operators can be used along with the suffix wildcard symbol `*`. See [instructions](https://docs.cloud.google.com/agent-registry/search-agents-and-tools) for more details. Allowed operators: `=`, `:`, `NOT`, `AND`, `OR`, and `()`. Searchable fields: | Field | `=` | `:` | `*` | Keyword Search | |--------------------|-----|-----|-----|----------------| | agentId | Yes | Yes | Yes | Included | | name | No | Yes | Yes | Included | | displayName | No | Yes | Yes | Included | | description | No | Yes | No | Included | | skills | No | Yes | No | Included | | skills.id | No | Yes | No | Included | | skills.name | No | Yes | No | Included | | skills.description | No | Yes | No | Included | | skills.tags | No | Yes | No | Included | | skills.examples | No | Yes | No | Included | Examples: * `agentId=urn:agent:projects-123:projects:123:locations:us-central1:reasoningEngines:1234` to find the agent with the specified agent ID. * `name:important` to find agents whose name contains `important` as a word. * `displayName:works*` to find agents whose display name contains words that start with `works`. * `skills.tags:test` to find agents whose skills tags contain `test`. * `planner OR booking` to find agents whose metadata contains the words `planner` or `booking`.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message for response to searching Agents
+  "agents": [ # A list of Agents that match the `search_string`.
+    { # Represents an Agent. "A2A" below refers to the Agent-to-Agent protocol.
+      "agentId": "A String", # Output only. A stable, globally unique identifier for agents.
+      "attributes": { # Output only. Attributes of the Agent. Valid values: * `agentregistry.googleapis.com/system/Framework`: {"framework": "google-adk"} - the agent framework used to develop the Agent. Example values: "google-adk", "langchain", "custom". * `agentregistry.googleapis.com/system/RuntimeIdentity`: {"principal": "principal://..."} - the runtime identity associated with the Agent. * `agentregistry.googleapis.com/system/RuntimeReference`: {"uri": "//..."} - the URI of the underlying resource hosting the Agent, for example, the Reasoning Engine URI.
+        "a_key": {
+          "a_key": "", # Properties of the object.
+        },
+      },
+      "card": { # Full Agent Card payload, often obtained from the A2A Agent Card. # Output only. Full Agent Card payload, when available.
+        "content": { # Output only. The content of the agent card.
+          "a_key": "", # Properties of the object.
+        },
+        "type": "A String", # Output only. The type of agent card.
+      },
+      "createTime": "A String", # Output only. Create time.
+      "description": "A String", # Output only. The description of the Agent, often obtained from the A2A Agent Card. Empty if Agent Card has no description.
+      "displayName": "A String", # Output only. The display name of the agent, often obtained from the A2A Agent Card.
+      "location": "A String", # Output only. The location where agent is hosted. The value is defined by the hosting environment (i.e. cloud provider).
+      "name": "A String", # Identifier. The resource name of an Agent. Format: `projects/{project}/locations/{location}/agents/{agent}`.
+      "protocols": [ # Output only. The connection details for the Agent.
+        { # Represents the protocol of an Agent.
+          "interfaces": [ # Output only. The connection details for the Agent.
+            { # Represents the connection details for an Agent or MCP Server.
+              "protocolBinding": "A String", # Required. The protocol binding of the interface.
+              "url": "A String", # Required. The destination URL.
+            },
+          ],
+          "protocolVersion": "A String", # Output only. The version of the protocol, for example, the A2A Agent Card version.
+          "type": "A String", # Output only. The type of the protocol.
+        },
+      ],
+      "skills": [ # Output only. Skills the agent possesses, often obtained from the A2A Agent Card.
+        { # Represents the skills of an Agent.
+          "description": "A String", # Output only. A more detailed description of the skill.
+          "examples": [ # Output only. Example prompts or scenarios this skill can handle.
+            "A String",
+          ],
+          "id": "A String", # Output only. A unique identifier for the agent's skill.
+          "name": "A String", # Output only. A human-readable name for the agent's skill.
+          "tags": [ # Output only. Keywords describing the skill.
+            "A String",
+          ],
+        },
+      ],
+      "uid": "A String", # Output only. A universally unique identifier for the Agent.
+      "updateTime": "A String", # Output only. Update time.
+      "version": "A String", # Output only. The version of the Agent, often obtained from the A2A Agent Card. Empty if Agent Card has no version or agent is not an A2A Agent.
+    },
+  ],
+  "nextPageToken": "A String", # If there are more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token`.
+}
+
+ +
+ search_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ \ No newline at end of file diff --git a/docs/dyn/agentregistry_v1alpha.projects.locations.mcpServers.html b/docs/dyn/agentregistry_v1alpha.projects.locations.mcpServers.html index 1983a1cb88..03af1328aa 100644 --- a/docs/dyn/agentregistry_v1alpha.projects.locations.mcpServers.html +++ b/docs/dyn/agentregistry_v1alpha.projects.locations.mcpServers.html @@ -86,6 +86,12 @@

Instance Methods

list_next()

Retrieves the next page of results.

+

+ search(parent, body=None, x__xgafv=None)

+

Searches McpServers in a given project and location.

+

+ search_next()

+

Retrieves the next page of results.

Method Details

close() @@ -211,4 +217,80 @@

Method Details

+
+ search(parent, body=None, x__xgafv=None) +
Searches McpServers in a given project and location.
+
+Args:
+  parent: string, Required. Parent value for SearchMcpServersRequest. Format: `projects/{project}/locations/{location}`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Message for searching MCP Servers
+  "pageSize": 42, # Optional. The maximum number of search results to return per page. The page size is capped at `100`, even if a larger value is specified. A negative value will result in an `INVALID_ARGUMENT` error. If unspecified or set to `0`, a default value of `20` will be used. The server may return fewer results than requested.
+  "pageToken": "A String", # Optional. If present, retrieve the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of all other method parameters, must be identical to those in the previous call.
+  "searchString": "A String", # Optional. Search criteria used to select the MCP Servers to return. If no search criteria is specified then all accessible MCP Servers will be returned. Search expressions can be used to restrict results based upon searchable fields, where the operators can be used along with the suffix wildcard symbol `*`. See [instructions](https://docs.cloud.google.com/agent-registry/search-agents-and-tools) for more details. Allowed operators: `=`, `:`, `NOT`, `AND`, `OR`, and `()`. Searchable fields: | Field | `=` | `:` | `*` | Keyword Search | |--------------------|-----|-----|-----|----------------| | mcpServerId | Yes | Yes | Yes | Included | | name | No | Yes | Yes | Included | | displayName | No | Yes | Yes | Included | Examples: * `mcpServerId=urn:mcp:projects-123:projects:123:locations:us-central1:agentregistry:services:service-id` to find the MCP Server with the specified MCP Server ID. * `name:important` to find MCP Servers whose name contains `important` as a word. * `displayName:works*` to find MCP Servers whose display name contains words that start with `works`. * `planner OR booking` to find MCP Servers whose metadata contains the words `planner` or `booking`. * `mcpServerId:service-id AND (displayName:planner OR displayName:booking)` to find MCP Servers whose MCP Server ID contains `service-id` and whose display name contains `planner` or `booking`.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message for response to searching MCP Servers
+  "mcpServers": [ # A list of McpServers that match the `search_string`.
+    { # Represents an MCP (Model Context Protocol) Server.
+      "attributes": { # Output only. Attributes of the MCP Server. Valid values: * `agentregistry.googleapis.com/system/RuntimeIdentity`: {"principal": "principal://..."} - the runtime identity associated with the MCP Server. * `agentregistry.googleapis.com/system/RuntimeReference`: {"uri": "//..."} - the URI of the underlying resource hosting the MCP Server, for example, the GKE Deployment.
+        "a_key": {
+          "a_key": "", # Properties of the object.
+        },
+      },
+      "createTime": "A String", # Output only. Create time.
+      "description": "A String", # Output only. The description of the MCP Server.
+      "displayName": "A String", # Output only. The display name of the MCP Server.
+      "interfaces": [ # Output only. The connection details for the MCP Server.
+        { # Represents the connection details for an Agent or MCP Server.
+          "protocolBinding": "A String", # Required. The protocol binding of the interface.
+          "url": "A String", # Required. The destination URL.
+        },
+      ],
+      "mcpServerId": "A String", # Output only. A stable, globally unique identifier for MCP Servers.
+      "name": "A String", # Identifier. The resource name of the MCP Server. Format: `projects/{project}/locations/{location}/mcpServers/{mcp_server}`.
+      "tools": [ # Output only. Tools provided by the MCP Server.
+        { # Represents a single tool provided by an MCP Server.
+          "annotations": { # Annotations describing the characteristics and behavior of a tool or operation. # Output only. Annotations associated with the tool.
+            "destructiveHint": True or False, # Output only. If true, the tool may perform destructive updates to its environment. If false, the tool performs only additive updates. NOTE: This property is meaningful only when `read_only_hint == false` Default: true
+            "idempotentHint": True or False, # Output only. If true, calling the tool repeatedly with the same arguments will have no additional effect on its environment. NOTE: This property is meaningful only when `read_only_hint == false. Default: false
+            "openWorldHint": True or False, # Output only. If true, this tool may interact with an "open world" of external entities. If false, the tool's domain of interaction is closed. For example, the world of a web search tool is open, whereas that of a memory tool is not. Default: true
+            "readOnlyHint": True or False, # Output only. If true, the tool does not modify its environment. Default: false
+            "title": "A String", # Output only. A human-readable title for the tool.
+          },
+          "description": "A String", # Output only. Description of what the tool does.
+          "name": "A String", # Output only. Human-readable name of the tool.
+        },
+      ],
+      "updateTime": "A String", # Output only. Update time.
+    },
+  ],
+  "nextPageToken": "A String", # If there are more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token`.
+}
+
+ +
+ search_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.endpoints.html b/docs/dyn/aiplatform_v1.endpoints.html index ece0ccfecc..b233bd224d 100644 --- a/docs/dyn/aiplatform_v1.endpoints.html +++ b/docs/dyn/aiplatform_v1.endpoints.html @@ -101,7 +101,7 @@

Instance Methods

Generate content with multimodal inputs.

predict(endpoint, body=None, x__xgafv=None)

-

Perform an online prediction.

+

predictLongRunning(endpoint, body=None, x__xgafv=None)

@@ -1599,7 +1599,7 @@

Method Details

predict(endpoint, body=None, x__xgafv=None) -
Perform an online prediction.
+  
 
 Args:
   endpoint: string, Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` (required)
diff --git a/docs/dyn/aiplatform_v1.projects.locations.endpoints.html b/docs/dyn/aiplatform_v1.projects.locations.endpoints.html
index 8892a4a53d..2805315ce1 100644
--- a/docs/dyn/aiplatform_v1.projects.locations.endpoints.html
+++ b/docs/dyn/aiplatform_v1.projects.locations.endpoints.html
@@ -154,7 +154,7 @@ 

Instance Methods

Updates an Endpoint.

predict(endpoint, body=None, x__xgafv=None)

-

Perform an online prediction.

+

predictLongRunning(endpoint, body=None, x__xgafv=None)

@@ -3817,7 +3817,7 @@

Method Details

predict(endpoint, body=None, x__xgafv=None) -
Perform an online prediction.
+  
 
 Args:
   endpoint: string, Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` (required)
diff --git a/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html b/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html
index 0e6bce10a4..2e6ef1201f 100644
--- a/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html
+++ b/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html
@@ -99,7 +99,7 @@ 

Instance Methods

Generate content with multimodal inputs.

predict(endpoint, body=None, x__xgafv=None)

-

Perform an online prediction.

+

predictLongRunning(endpoint, body=None, x__xgafv=None)

@@ -1755,7 +1755,7 @@

Method Details

predict(endpoint, body=None, x__xgafv=None) -
Perform an online prediction.
+  
 
 Args:
   endpoint: string, Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` (required)
diff --git a/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.memories.html b/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.memories.html
index fd71aed8b7..f3fd5c811e 100644
--- a/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.memories.html
+++ b/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.memories.html
@@ -138,7 +138,7 @@ 

Method Details

"disableMemoryRevisions": True or False, # Optional. Input only. If true, no revision will be created for this request. "displayName": "A String", # Optional. Display name of the Memory. "expireTime": "A String", # Optional. Timestamp of when this resource is considered expired. This is *always* provided on output when `expiration` is set on input, regardless of whether `expire_time` or `ttl` was provided. - "fact": "A String", # Required. Semantic knowledge extracted from the source content. + "fact": "A String", # Optional. Semantic knowledge extracted from the source content. "metadata": { # Optional. User-provided metadata for the Memory. This information was provided when creating, updating, or generating the Memory. It was not generated by Memory Bank. "a_key": { # Memory metadata. "boolValue": True or False, # Boolean value. @@ -409,7 +409,7 @@

Method Details

"disableMemoryRevisions": True or False, # Optional. Input only. If true, no revision will be created for this request. "displayName": "A String", # Optional. Display name of the Memory. "expireTime": "A String", # Optional. Timestamp of when this resource is considered expired. This is *always* provided on output when `expiration` is set on input, regardless of whether `expire_time` or `ttl` was provided. - "fact": "A String", # Required. Semantic knowledge extracted from the source content. + "fact": "A String", # Optional. Semantic knowledge extracted from the source content. "metadata": { # Optional. User-provided metadata for the Memory. This information was provided when creating, updating, or generating the Memory. It was not generated by Memory Bank. "a_key": { # Memory metadata. "boolValue": True or False, # Boolean value. @@ -464,7 +464,7 @@

Method Details

"disableMemoryRevisions": True or False, # Optional. Input only. If true, no revision will be created for this request. "displayName": "A String", # Optional. Display name of the Memory. "expireTime": "A String", # Optional. Timestamp of when this resource is considered expired. This is *always* provided on output when `expiration` is set on input, regardless of whether `expire_time` or `ttl` was provided. - "fact": "A String", # Required. Semantic knowledge extracted from the source content. + "fact": "A String", # Optional. Semantic knowledge extracted from the source content. "metadata": { # Optional. User-provided metadata for the Memory. This information was provided when creating, updating, or generating the Memory. It was not generated by Memory Bank. "a_key": { # Memory metadata. "boolValue": True or False, # Boolean value. @@ -525,7 +525,7 @@

Method Details

"disableMemoryRevisions": True or False, # Optional. Input only. If true, no revision will be created for this request. "displayName": "A String", # Optional. Display name of the Memory. "expireTime": "A String", # Optional. Timestamp of when this resource is considered expired. This is *always* provided on output when `expiration` is set on input, regardless of whether `expire_time` or `ttl` was provided. - "fact": "A String", # Required. Semantic knowledge extracted from the source content. + "fact": "A String", # Optional. Semantic knowledge extracted from the source content. "metadata": { # Optional. User-provided metadata for the Memory. This information was provided when creating, updating, or generating the Memory. It was not generated by Memory Bank. "a_key": { # Memory metadata. "boolValue": True or False, # Boolean value. @@ -703,7 +703,7 @@

Method Details

"disableMemoryRevisions": True or False, # Optional. Input only. If true, no revision will be created for this request. "displayName": "A String", # Optional. Display name of the Memory. "expireTime": "A String", # Optional. Timestamp of when this resource is considered expired. This is *always* provided on output when `expiration` is set on input, regardless of whether `expire_time` or `ttl` was provided. - "fact": "A String", # Required. Semantic knowledge extracted from the source content. + "fact": "A String", # Optional. Semantic knowledge extracted from the source content. "metadata": { # Optional. User-provided metadata for the Memory. This information was provided when creating, updating, or generating the Memory. It was not generated by Memory Bank. "a_key": { # Memory metadata. "boolValue": True or False, # Boolean value. diff --git a/docs/dyn/aiplatform_v1.publishers.models.html b/docs/dyn/aiplatform_v1.publishers.models.html index 569ef2be5e..f578319b3e 100644 --- a/docs/dyn/aiplatform_v1.publishers.models.html +++ b/docs/dyn/aiplatform_v1.publishers.models.html @@ -94,7 +94,7 @@

Instance Methods

Gets a Model Garden publisher model.

predict(endpoint, body=None, x__xgafv=None)

-

Perform an online prediction.

+

predictLongRunning(endpoint, body=None, x__xgafv=None)

@@ -2167,7 +2167,7 @@

Method Details

predict(endpoint, body=None, x__xgafv=None) -
Perform an online prediction.
+  
 
 Args:
   endpoint: string, Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` (required)
diff --git a/docs/dyn/aiplatform_v1beta1.endpoints.html b/docs/dyn/aiplatform_v1beta1.endpoints.html
index 6dc7cfcb3e..1a3fcd928b 100644
--- a/docs/dyn/aiplatform_v1beta1.endpoints.html
+++ b/docs/dyn/aiplatform_v1beta1.endpoints.html
@@ -101,7 +101,7 @@ 

Instance Methods

Generate content with multimodal inputs.

predict(endpoint, body=None, x__xgafv=None)

-

Perform an online prediction.

+

predictLongRunning(endpoint, body=None, x__xgafv=None)

@@ -1634,7 +1634,7 @@

Method Details

predict(endpoint, body=None, x__xgafv=None) -
Perform an online prediction.
+  
 
 Args:
   endpoint: string, Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` (required)
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html b/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html
index c8eb1253ff..2139008c04 100644
--- a/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html
+++ b/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html
@@ -157,7 +157,7 @@ 

Instance Methods

Updates an Endpoint.

predict(endpoint, body=None, x__xgafv=None)

-

Perform an online prediction.

+

predictLongRunning(endpoint, body=None, x__xgafv=None)

@@ -4260,7 +4260,7 @@

Method Details

predict(endpoint, body=None, x__xgafv=None) -
Perform an online prediction.
+  
 
 Args:
   endpoint: string, Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` (required)
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationRuns.html b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationRuns.html
index 4d3cadf59f..8d8d4f0cd1 100644
--- a/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationRuns.html
+++ b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationRuns.html
@@ -295,6 +295,12 @@ 

Method Details

"displayName": "A String", # Optional. A display name for this custom summary metric. Used to prefix keys in the output summaryMetrics map. If not provided, a default name like "dataset_custom_metric_1", "dataset_custom_metric_2", etc., will be generated based on the order in the repeated field. }, ], + "lossAnalysisConfig": [ # Optional. Specifications for loss analysis. Each config can be specified for one metric. + { # Configuration for the loss analysis job. + "candidate": "A String", # Required. The candidate model/agent to analyze (e.g., "gemini-3.0-pro"). This targets the specific CandidateResult within the EvaluationResult. + "metric": "A String", # Required. The metric to analyze (e.g., "tool_use_quality"). This filters the EvaluationItems in the EvalSet to only those where EvaluationResult.metric matches this value. + }, + ], "metrics": [ # Required. The metrics to be calculated in the evaluation run. { # The metric used for evaluation runs. "computationBasedMetricSpec": { # Specification for a computation based metric. # Spec for a computation based metric. @@ -1316,6 +1322,2012 @@

Method Details

}, "evaluationResults": { # The results of the evaluation run. # Output only. The results of the evaluation run. Only populated when the evaluation run's state is SUCCEEDED. "evaluationSet": "A String", # The evaluation set where item level results are stored. + "lossAnalysisResults": [ # Output only. The results of the auto-loss analysis performed on the eval set associated with the run. + { # The top-level result for loss analysis, stored within an EvalSet. + "analysisTime": "A String", # The timestamp when this analysis was performed. + "clusters": [ # The list of identified loss clusters. + { # Represents a semantic grouping of failures (e.g., "Hallucination of Action"). + "clusterId": "A String", # Unique identifier for the loss cluster within the scope of the analysis result. + "examples": [ # A list of examples that belong to this cluster. This links the cluster back to the specific EvaluationItems and Rubrics. + { # Represents a specific example of a loss pattern. + "evaluationItem": "A String", # Reference to the persisted EvalItem resource name. Format: projects/.../locations/.../evaluationItems/{item_id} Used when analysis is run on an EvalSet. + "evaluationResult": { # Evaluation result. # The full evaluation result object provided inline. Used when the analysis is performed on ephemeral data (without an EvaluationSet). + "candidateResults": [ # Optional. The results for the metric. + { # Result for a single candidate. + "additionalResults": "", # Optional. Additional results for the metric. + "candidate": "A String", # Required. The candidate that is being evaluated. The value is the same as the candidate name in the EvaluationRequest. + "explanation": "A String", # Optional. The explanation for the metric. + "metric": "A String", # Required. The metric that was evaluated. + "rubricVerdicts": [ # Optional. The rubric verdicts for the metric. + { # Represents the verdict of an evaluation against a single rubric. + "evaluatedRubric": { # Message representing a single testable criterion for evaluation. One input prompt could have multiple rubrics. # Required. The full rubric definition that was evaluated. Storing this ensures the verdict is self-contained and understandable, especially if the original rubric definition changes or was dynamically generated. + "content": { # Content of the rubric, defining the testable criteria. # Required. The actual testable criteria for the rubric. + "property": { # Defines criteria based on a specific property. # Evaluation criteria based on a specific property. + "description": "A String", # Description of the property being evaluated. Example: "The model's response is grammatically correct." + }, + }, + "importance": "A String", # Optional. The relative importance of this rubric. + "rubricId": "A String", # Unique identifier for the rubric. This ID is used to refer to this rubric, e.g., in RubricVerdict. + "type": "A String", # Optional. A type designator for the rubric, which can inform how it's evaluated or interpreted by systems or users. It's recommended to use consistent, well-defined, upper snake_case strings. Examples: "SUMMARIZATION_QUALITY", "SAFETY_HARMFUL_CONTENT", "INSTRUCTION_ADHERENCE". + }, + "reasoning": "A String", # Optional. Human-readable reasoning or explanation for the verdict. This can include specific examples or details from the evaluated content that justify the given verdict. + "verdict": True or False, # Required. Outcome of the evaluation against the rubric, represented as a boolean. `true` indicates a "Pass", `false` indicates a "Fail". + }, + ], + "score": 3.14, # Optional. The score for the metric. + }, + ], + "evaluationRequest": "A String", # Required. The request item that was evaluated. Format: projects/{project}/locations/{location}/evaluationItems/{evaluation_item} + "evaluationRun": "A String", # Required. The evaluation run that was used to generate the result. Format: projects/{project}/locations/{location}/evaluationRuns/{evaluation_run} + "metadata": "", # Optional. Metadata about the evaluation result. + "metric": "A String", # Required. The metric that was evaluated. + "request": { # A single evaluation request supporting input for both single-turn model generation and multi-turn agent execution traces. Valid input modes: 1. Inference Mode: `prompt` is set (containing text or AgentData context). 2. Offline Eval Mode: `prompt` is unset, and `candidate_responses` contains `agent_data` (the completed execution trace). Validation Rule: Either `prompt` must be set, OR at least one of the `candidate_responses` must contain `agent_data`. # Required. The request that was evaluated. + "candidateResponses": [ # Optional. Responses from model under test and other baseline models for comparison. + { # Responses from model or agent. + "agentData": { # Represents data specific to multi-turn agent evaluations. # Optional. Represents the complete execution trace of a multi-turn conversation, which can involve single or multiple agents. This field is used to provide the full output of an agent's run, including all turns and events, for direct evaluation. + "agents": { # Optional. A map containing the static configurations for each agent in the system. Key: agent_id (matches the `author` field in events). Value: The static configuration of the agent. + "a_key": { # Represents configuration for an Agent. + "agentId": "A String", # Required. Unique identifier of the agent. This ID is used to refer to this agent, e.g., in AgentEvent.author, or in the `sub_agents` field. It must be unique within the `agents` map. + "agentType": "A String", # Optional. The type or class of the agent (e.g., "LlmAgent", "RouterAgent", "ToolUseAgent"). Useful for the autorater to understand the expected behavior of the agent. + "description": "A String", # Optional. A high-level description of the agent's role and responsibilities. Critical for evaluating if the agent is routing tasks correctly. + "instruction": "A String", # Optional. Provides instructions for the LLM model, guiding the agent's behavior. Can be static or dynamic. Dynamic instructions can contain placeholders like {variable_name} that will be resolved at runtime using the `AgentEvent.state_delta` field. + "subAgents": [ # Optional. The list of valid agent IDs that this agent can delegate to. This defines the directed edges in the multi-agent system graph topology. + "A String", + ], + "tools": [ # Optional. The list of tools available to this agent. + { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. + }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, + "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. + "A String", + ], + }, + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. + "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1beta1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. + "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1beta1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. + }, + ], + "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. If true, include the widget context token in the response. + }, + "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. + "A String", + ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, + }, + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. + "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. + "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. + "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. + }, + }, + "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation + "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more details. + "customConfigs": { # Optional. Custom configs for ParallelAiSearch. This field can be used to pass any parameter from the Parallel.ai Search API. See the Parallel.ai documentation for the full list of available parameters and their usage: https://docs.parallel.ai/api-reference/search-beta/search Currently only `source_policy`, `excerpts`, `max_results`, `mode`, `fetch_policy` can be set via this field. For example: { "source_policy": { "include_domains": ["google.com", "wikipedia.org"], "exclude_domains": ["example.com"] }, "fetch_policy": { "max_age_seconds": 3600 } } + "a_key": "", # Properties of the object. + }, + }, + "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. + "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported. + "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. + "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. + }, + }, + "apiSpec": "A String", # The API spec that the external API implements. + "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. + "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. + "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + "apiKeyString": "A String", # Optional. The API key to be used in the request directly. + "httpElementLocation": "A String", # Optional. The location of the API key. + "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + }, + "authType": "A String", # Type of auth scheme. + "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. + "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + }, + "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. + "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + }, + "oauthConfig": { # Config for user oauth. # Config for user oauth. + "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + }, + "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. + "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + }, + }, + "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. + "index": "A String", # The ElasticSearch index to use. + "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. + "searchTemplate": "A String", # The ElasticSearch search template to use. + }, + "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search + "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. + }, + }, + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. + { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec + "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + ], + "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + "filter": "A String", # Optional. Filter strings to be passed to the search API. + "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. + }, + "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. + "ragCorpora": [ # Optional. Deprecated. Please use rag_resources instead. + "A String", + ], + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "hybridSearch": { # Config for Hybrid Search. # Optional. Config for Hybrid Search. + "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. The range is [0, 1], while 0 means sparse vector search only and 1 means dense vector search only. The default value is 0.5 which balances sparse and dense vector search equally. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. + "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + }, + "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` + }, + }, + "topK": 42, # Optional. The number of contexts to retrieve. + }, + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "storeContext": True or False, # Optional. Currently only supported for Gemini Multimodal Live API. In Gemini Multimodal Live API, if `store_context` bool is specified, Gemini will leverage it to automatically memorize the interactions between the client and Gemini, and retrieve context when needed to augment the response generation for users' ongoing and future interactions. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, + }, + ], + }, + }, + "turns": [ # Optional. A chronological list of conversation turns. Each turn represents a logical execution cycle (e.g., User Input -> Agent Response). + { # Represents a single turn/invocation in the conversation. + "events": [ # Optional. The list of events that occurred during this turn. + { # Represents a single event in the execution trace. + "activeTools": [ # Optional. The list of tools that were active/available to the agent at the time of this event. This overrides the `AgentConfig.tools` if set. + { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. + }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, + "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. + "A String", + ], + }, + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. + "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1beta1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. + "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1beta1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. + }, + ], + "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. If true, include the widget context token in the response. + }, + "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. + "A String", + ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, + }, + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. + "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. + "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. + "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. + }, + }, + "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation + "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more details. + "customConfigs": { # Optional. Custom configs for ParallelAiSearch. This field can be used to pass any parameter from the Parallel.ai Search API. See the Parallel.ai documentation for the full list of available parameters and their usage: https://docs.parallel.ai/api-reference/search-beta/search Currently only `source_policy`, `excerpts`, `max_results`, `mode`, `fetch_policy` can be set via this field. For example: { "source_policy": { "include_domains": ["google.com", "wikipedia.org"], "exclude_domains": ["example.com"] }, "fetch_policy": { "max_age_seconds": 3600 } } + "a_key": "", # Properties of the object. + }, + }, + "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. + "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported. + "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. + "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. + }, + }, + "apiSpec": "A String", # The API spec that the external API implements. + "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. + "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. + "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + "apiKeyString": "A String", # Optional. The API key to be used in the request directly. + "httpElementLocation": "A String", # Optional. The location of the API key. + "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + }, + "authType": "A String", # Type of auth scheme. + "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. + "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + }, + "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. + "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + }, + "oauthConfig": { # Config for user oauth. # Config for user oauth. + "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + }, + "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. + "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + }, + }, + "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. + "index": "A String", # The ElasticSearch index to use. + "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. + "searchTemplate": "A String", # The ElasticSearch search template to use. + }, + "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search + "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. + }, + }, + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. + { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec + "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + ], + "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + "filter": "A String", # Optional. Filter strings to be passed to the search API. + "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. + }, + "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. + "ragCorpora": [ # Optional. Deprecated. Please use rag_resources instead. + "A String", + ], + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "hybridSearch": { # Config for Hybrid Search. # Optional. Config for Hybrid Search. + "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. The range is [0, 1], while 0 means sparse vector search only and 1 means dense vector search only. The default value is 0.5 which balances sparse and dense vector search equally. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. + "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + }, + "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` + }, + }, + "topK": 42, # Optional. The number of contexts to retrieve. + }, + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "storeContext": True or False, # Optional. Currently only supported for Gemini Multimodal Live API. In Gemini Multimodal Live API, if `store_context` bool is specified, Gemini will leverage it to automatically memorize the interactions between the client and Gemini, and retrieve context when needed to augment the response generation for users' ongoing and future interactions. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, + }, + ], + "author": "A String", # Required. The ID of the agent or entity that generated this event. Use "user" to denote events generated by the end-user. + "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. + "code": "A String", # Required. The code to be executed. + "language": "A String", # Required. Programming language of the `code`. + }, + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "functionCall": { # A predicted FunctionCall returned from the model that contains a string representing the FunctionDeclaration.name and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. + "a_key": "", # Properties of the object. + }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. + "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. + "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. + { # Partial argument value of the function call. + "boolValue": True or False, # Optional. Represents a boolean value. + "jsonPath": "A String", # Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data". + "nullValue": "A String", # Optional. Represents a null value. + "numberValue": 3.14, # Optional. Represents a double value. + "stringValue": "A String", # Optional. Represents a string value. + "willContinue": True or False, # Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow. + }, + ], + "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. + }, + "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. + "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. + "a_key": "", # Properties of the object. + }, + "scheduling": "A String", # Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE. + }, + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. + "level": "A String", # The tokenization quality used for given media. + }, + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "endOffset": "A String", # Optional. The end offset of the video. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + "eventTime": "A String", # Optional. The timestamp when the event occurred. + "stateDelta": { # Optional. The change in the session state caused by this event. This is a key-value map of fields that were modified or added by the event. + "a_key": "", # Properties of the object. + }, + }, + ], + "turnId": "A String", # Optional. A unique identifier for the turn. Useful for referencing specific turns across systems. + "turnIndex": 42, # Required. The 0-based index of the turn in the conversation sequence. + }, + ], + }, + "candidate": "A String", # Required. The name of the candidate that produced the response. + "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). # Output only. Error while scraping model or agent. + "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. + }, + "events": [ # Optional. Intermediate events (such as tool calls and responses) that led to the final response. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. + "code": "A String", # Required. The code to be executed. + "language": "A String", # Required. Programming language of the `code`. + }, + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "functionCall": { # A predicted FunctionCall returned from the model that contains a string representing the FunctionDeclaration.name and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. + "a_key": "", # Properties of the object. + }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. + "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. + "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. + { # Partial argument value of the function call. + "boolValue": True or False, # Optional. Represents a boolean value. + "jsonPath": "A String", # Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data". + "nullValue": "A String", # Optional. Represents a null value. + "numberValue": 3.14, # Optional. Represents a double value. + "stringValue": "A String", # Optional. Represents a string value. + "willContinue": True or False, # Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow. + }, + ], + "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. + }, + "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. + "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. + "a_key": "", # Properties of the object. + }, + "scheduling": "A String", # Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE. + }, + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. + "level": "A String", # The tokenization quality used for given media. + }, + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "endOffset": "A String", # Optional. The end offset of the video. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + ], + "text": "A String", # Text response. + "value": "", # Fields and values that can be used to populate the response template. + }, + ], + "goldenResponse": { # Responses from model or agent. # Optional. The Ideal response or ground truth. + "agentData": { # Represents data specific to multi-turn agent evaluations. # Optional. Represents the complete execution trace of a multi-turn conversation, which can involve single or multiple agents. This field is used to provide the full output of an agent's run, including all turns and events, for direct evaluation. + "agents": { # Optional. A map containing the static configurations for each agent in the system. Key: agent_id (matches the `author` field in events). Value: The static configuration of the agent. + "a_key": { # Represents configuration for an Agent. + "agentId": "A String", # Required. Unique identifier of the agent. This ID is used to refer to this agent, e.g., in AgentEvent.author, or in the `sub_agents` field. It must be unique within the `agents` map. + "agentType": "A String", # Optional. The type or class of the agent (e.g., "LlmAgent", "RouterAgent", "ToolUseAgent"). Useful for the autorater to understand the expected behavior of the agent. + "description": "A String", # Optional. A high-level description of the agent's role and responsibilities. Critical for evaluating if the agent is routing tasks correctly. + "instruction": "A String", # Optional. Provides instructions for the LLM model, guiding the agent's behavior. Can be static or dynamic. Dynamic instructions can contain placeholders like {variable_name} that will be resolved at runtime using the `AgentEvent.state_delta` field. + "subAgents": [ # Optional. The list of valid agent IDs that this agent can delegate to. This defines the directed edges in the multi-agent system graph topology. + "A String", + ], + "tools": [ # Optional. The list of tools available to this agent. + { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. + }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, + "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. + "A String", + ], + }, + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. + "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1beta1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. + "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1beta1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. + }, + ], + "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. If true, include the widget context token in the response. + }, + "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. + "A String", + ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, + }, + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. + "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. + "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. + "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. + }, + }, + "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation + "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more details. + "customConfigs": { # Optional. Custom configs for ParallelAiSearch. This field can be used to pass any parameter from the Parallel.ai Search API. See the Parallel.ai documentation for the full list of available parameters and their usage: https://docs.parallel.ai/api-reference/search-beta/search Currently only `source_policy`, `excerpts`, `max_results`, `mode`, `fetch_policy` can be set via this field. For example: { "source_policy": { "include_domains": ["google.com", "wikipedia.org"], "exclude_domains": ["example.com"] }, "fetch_policy": { "max_age_seconds": 3600 } } + "a_key": "", # Properties of the object. + }, + }, + "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. + "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported. + "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. + "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. + }, + }, + "apiSpec": "A String", # The API spec that the external API implements. + "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. + "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. + "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + "apiKeyString": "A String", # Optional. The API key to be used in the request directly. + "httpElementLocation": "A String", # Optional. The location of the API key. + "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + }, + "authType": "A String", # Type of auth scheme. + "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. + "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + }, + "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. + "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + }, + "oauthConfig": { # Config for user oauth. # Config for user oauth. + "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + }, + "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. + "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + }, + }, + "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. + "index": "A String", # The ElasticSearch index to use. + "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. + "searchTemplate": "A String", # The ElasticSearch search template to use. + }, + "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search + "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. + }, + }, + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. + { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec + "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + ], + "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + "filter": "A String", # Optional. Filter strings to be passed to the search API. + "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. + }, + "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. + "ragCorpora": [ # Optional. Deprecated. Please use rag_resources instead. + "A String", + ], + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "hybridSearch": { # Config for Hybrid Search. # Optional. Config for Hybrid Search. + "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. The range is [0, 1], while 0 means sparse vector search only and 1 means dense vector search only. The default value is 0.5 which balances sparse and dense vector search equally. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. + "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + }, + "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` + }, + }, + "topK": 42, # Optional. The number of contexts to retrieve. + }, + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "storeContext": True or False, # Optional. Currently only supported for Gemini Multimodal Live API. In Gemini Multimodal Live API, if `store_context` bool is specified, Gemini will leverage it to automatically memorize the interactions between the client and Gemini, and retrieve context when needed to augment the response generation for users' ongoing and future interactions. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, + }, + ], + }, + }, + "turns": [ # Optional. A chronological list of conversation turns. Each turn represents a logical execution cycle (e.g., User Input -> Agent Response). + { # Represents a single turn/invocation in the conversation. + "events": [ # Optional. The list of events that occurred during this turn. + { # Represents a single event in the execution trace. + "activeTools": [ # Optional. The list of tools that were active/available to the agent at the time of this event. This overrides the `AgentConfig.tools` if set. + { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. + }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, + "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. + "A String", + ], + }, + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. + "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1beta1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. + "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1beta1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. + }, + ], + "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. If true, include the widget context token in the response. + }, + "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. + "A String", + ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, + }, + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. + "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. + "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. + "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. + }, + }, + "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation + "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more details. + "customConfigs": { # Optional. Custom configs for ParallelAiSearch. This field can be used to pass any parameter from the Parallel.ai Search API. See the Parallel.ai documentation for the full list of available parameters and their usage: https://docs.parallel.ai/api-reference/search-beta/search Currently only `source_policy`, `excerpts`, `max_results`, `mode`, `fetch_policy` can be set via this field. For example: { "source_policy": { "include_domains": ["google.com", "wikipedia.org"], "exclude_domains": ["example.com"] }, "fetch_policy": { "max_age_seconds": 3600 } } + "a_key": "", # Properties of the object. + }, + }, + "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. + "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported. + "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. + "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. + }, + }, + "apiSpec": "A String", # The API spec that the external API implements. + "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. + "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. + "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + "apiKeyString": "A String", # Optional. The API key to be used in the request directly. + "httpElementLocation": "A String", # Optional. The location of the API key. + "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + }, + "authType": "A String", # Type of auth scheme. + "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. + "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + }, + "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. + "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + }, + "oauthConfig": { # Config for user oauth. # Config for user oauth. + "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + }, + "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. + "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + }, + }, + "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. + "index": "A String", # The ElasticSearch index to use. + "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. + "searchTemplate": "A String", # The ElasticSearch search template to use. + }, + "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search + "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. + }, + }, + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. + { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec + "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + ], + "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + "filter": "A String", # Optional. Filter strings to be passed to the search API. + "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. + }, + "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. + "ragCorpora": [ # Optional. Deprecated. Please use rag_resources instead. + "A String", + ], + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "hybridSearch": { # Config for Hybrid Search. # Optional. Config for Hybrid Search. + "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. The range is [0, 1], while 0 means sparse vector search only and 1 means dense vector search only. The default value is 0.5 which balances sparse and dense vector search equally. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. + "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + }, + "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` + }, + }, + "topK": 42, # Optional. The number of contexts to retrieve. + }, + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "storeContext": True or False, # Optional. Currently only supported for Gemini Multimodal Live API. In Gemini Multimodal Live API, if `store_context` bool is specified, Gemini will leverage it to automatically memorize the interactions between the client and Gemini, and retrieve context when needed to augment the response generation for users' ongoing and future interactions. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, + }, + ], + "author": "A String", # Required. The ID of the agent or entity that generated this event. Use "user" to denote events generated by the end-user. + "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. + "code": "A String", # Required. The code to be executed. + "language": "A String", # Required. Programming language of the `code`. + }, + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "functionCall": { # A predicted FunctionCall returned from the model that contains a string representing the FunctionDeclaration.name and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. + "a_key": "", # Properties of the object. + }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. + "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. + "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. + { # Partial argument value of the function call. + "boolValue": True or False, # Optional. Represents a boolean value. + "jsonPath": "A String", # Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data". + "nullValue": "A String", # Optional. Represents a null value. + "numberValue": 3.14, # Optional. Represents a double value. + "stringValue": "A String", # Optional. Represents a string value. + "willContinue": True or False, # Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow. + }, + ], + "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. + }, + "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. + "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. + "a_key": "", # Properties of the object. + }, + "scheduling": "A String", # Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE. + }, + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. + "level": "A String", # The tokenization quality used for given media. + }, + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "endOffset": "A String", # Optional. The end offset of the video. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + "eventTime": "A String", # Optional. The timestamp when the event occurred. + "stateDelta": { # Optional. The change in the session state caused by this event. This is a key-value map of fields that were modified or added by the event. + "a_key": "", # Properties of the object. + }, + }, + ], + "turnId": "A String", # Optional. A unique identifier for the turn. Useful for referencing specific turns across systems. + "turnIndex": 42, # Required. The 0-based index of the turn in the conversation sequence. + }, + ], + }, + "candidate": "A String", # Required. The name of the candidate that produced the response. + "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). # Output only. Error while scraping model or agent. + "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. + }, + "events": [ # Optional. Intermediate events (such as tool calls and responses) that led to the final response. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. + "code": "A String", # Required. The code to be executed. + "language": "A String", # Required. Programming language of the `code`. + }, + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "functionCall": { # A predicted FunctionCall returned from the model that contains a string representing the FunctionDeclaration.name and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. + "a_key": "", # Properties of the object. + }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. + "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. + "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. + { # Partial argument value of the function call. + "boolValue": True or False, # Optional. Represents a boolean value. + "jsonPath": "A String", # Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data". + "nullValue": "A String", # Optional. Represents a null value. + "numberValue": 3.14, # Optional. Represents a double value. + "stringValue": "A String", # Optional. Represents a string value. + "willContinue": True or False, # Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow. + }, + ], + "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. + }, + "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. + "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. + "a_key": "", # Properties of the object. + }, + "scheduling": "A String", # Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE. + }, + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. + "level": "A String", # The tokenization quality used for given media. + }, + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "endOffset": "A String", # Optional. The end offset of the video. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + ], + "text": "A String", # Text response. + "value": "", # Fields and values that can be used to populate the response template. + }, + "prompt": { # Prompt to be evaluated. This can represent a single-turn prompt or a multi-turn conversation for agent evaluations. # Optional. The request/prompt to evaluate. + "agentData": { # Represents data specific to multi-turn agent evaluations. # Optional. Represents the complete execution trace of a multi-turn conversation, which can involve single or multiple agents. This serves as the input context for agent scraping. + "agents": { # Optional. A map containing the static configurations for each agent in the system. Key: agent_id (matches the `author` field in events). Value: The static configuration of the agent. + "a_key": { # Represents configuration for an Agent. + "agentId": "A String", # Required. Unique identifier of the agent. This ID is used to refer to this agent, e.g., in AgentEvent.author, or in the `sub_agents` field. It must be unique within the `agents` map. + "agentType": "A String", # Optional. The type or class of the agent (e.g., "LlmAgent", "RouterAgent", "ToolUseAgent"). Useful for the autorater to understand the expected behavior of the agent. + "description": "A String", # Optional. A high-level description of the agent's role and responsibilities. Critical for evaluating if the agent is routing tasks correctly. + "instruction": "A String", # Optional. Provides instructions for the LLM model, guiding the agent's behavior. Can be static or dynamic. Dynamic instructions can contain placeholders like {variable_name} that will be resolved at runtime using the `AgentEvent.state_delta` field. + "subAgents": [ # Optional. The list of valid agent IDs that this agent can delegate to. This defines the directed edges in the multi-agent system graph topology. + "A String", + ], + "tools": [ # Optional. The list of tools available to this agent. + { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. + }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, + "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. + "A String", + ], + }, + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. + "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1beta1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. + "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1beta1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. + }, + ], + "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. If true, include the widget context token in the response. + }, + "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. + "A String", + ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, + }, + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. + "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. + "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. + "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. + }, + }, + "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation + "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more details. + "customConfigs": { # Optional. Custom configs for ParallelAiSearch. This field can be used to pass any parameter from the Parallel.ai Search API. See the Parallel.ai documentation for the full list of available parameters and their usage: https://docs.parallel.ai/api-reference/search-beta/search Currently only `source_policy`, `excerpts`, `max_results`, `mode`, `fetch_policy` can be set via this field. For example: { "source_policy": { "include_domains": ["google.com", "wikipedia.org"], "exclude_domains": ["example.com"] }, "fetch_policy": { "max_age_seconds": 3600 } } + "a_key": "", # Properties of the object. + }, + }, + "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. + "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported. + "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. + "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. + }, + }, + "apiSpec": "A String", # The API spec that the external API implements. + "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. + "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. + "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + "apiKeyString": "A String", # Optional. The API key to be used in the request directly. + "httpElementLocation": "A String", # Optional. The location of the API key. + "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + }, + "authType": "A String", # Type of auth scheme. + "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. + "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + }, + "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. + "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + }, + "oauthConfig": { # Config for user oauth. # Config for user oauth. + "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + }, + "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. + "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + }, + }, + "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. + "index": "A String", # The ElasticSearch index to use. + "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. + "searchTemplate": "A String", # The ElasticSearch search template to use. + }, + "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search + "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. + }, + }, + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. + { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec + "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + ], + "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + "filter": "A String", # Optional. Filter strings to be passed to the search API. + "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. + }, + "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. + "ragCorpora": [ # Optional. Deprecated. Please use rag_resources instead. + "A String", + ], + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "hybridSearch": { # Config for Hybrid Search. # Optional. Config for Hybrid Search. + "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. The range is [0, 1], while 0 means sparse vector search only and 1 means dense vector search only. The default value is 0.5 which balances sparse and dense vector search equally. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. + "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + }, + "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` + }, + }, + "topK": 42, # Optional. The number of contexts to retrieve. + }, + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "storeContext": True or False, # Optional. Currently only supported for Gemini Multimodal Live API. In Gemini Multimodal Live API, if `store_context` bool is specified, Gemini will leverage it to automatically memorize the interactions between the client and Gemini, and retrieve context when needed to augment the response generation for users' ongoing and future interactions. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, + }, + ], + }, + }, + "turns": [ # Optional. A chronological list of conversation turns. Each turn represents a logical execution cycle (e.g., User Input -> Agent Response). + { # Represents a single turn/invocation in the conversation. + "events": [ # Optional. The list of events that occurred during this turn. + { # Represents a single event in the execution trace. + "activeTools": [ # Optional. The list of tools that were active/available to the agent at the time of this event. This overrides the `AgentConfig.tools` if set. + { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. + }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, + "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. + "A String", + ], + }, + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. + "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1beta1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. + "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1beta1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. + }, + ], + "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. If true, include the widget context token in the response. + }, + "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. + "A String", + ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, + }, + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. + "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. + "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. + "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. + }, + }, + "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation + "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more details. + "customConfigs": { # Optional. Custom configs for ParallelAiSearch. This field can be used to pass any parameter from the Parallel.ai Search API. See the Parallel.ai documentation for the full list of available parameters and their usage: https://docs.parallel.ai/api-reference/search-beta/search Currently only `source_policy`, `excerpts`, `max_results`, `mode`, `fetch_policy` can be set via this field. For example: { "source_policy": { "include_domains": ["google.com", "wikipedia.org"], "exclude_domains": ["example.com"] }, "fetch_policy": { "max_age_seconds": 3600 } } + "a_key": "", # Properties of the object. + }, + }, + "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. + "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported. + "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. + "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. + }, + }, + "apiSpec": "A String", # The API spec that the external API implements. + "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. + "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. + "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + "apiKeyString": "A String", # Optional. The API key to be used in the request directly. + "httpElementLocation": "A String", # Optional. The location of the API key. + "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + }, + "authType": "A String", # Type of auth scheme. + "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. + "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + }, + "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. + "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + }, + "oauthConfig": { # Config for user oauth. # Config for user oauth. + "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + }, + "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. + "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + }, + }, + "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. + "index": "A String", # The ElasticSearch index to use. + "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. + "searchTemplate": "A String", # The ElasticSearch search template to use. + }, + "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search + "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. + }, + }, + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. + { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec + "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + ], + "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + "filter": "A String", # Optional. Filter strings to be passed to the search API. + "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. + }, + "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. + "ragCorpora": [ # Optional. Deprecated. Please use rag_resources instead. + "A String", + ], + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "hybridSearch": { # Config for Hybrid Search. # Optional. Config for Hybrid Search. + "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. The range is [0, 1], while 0 means sparse vector search only and 1 means dense vector search only. The default value is 0.5 which balances sparse and dense vector search equally. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. + "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + }, + "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` + }, + }, + "topK": 42, # Optional. The number of contexts to retrieve. + }, + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "storeContext": True or False, # Optional. Currently only supported for Gemini Multimodal Live API. In Gemini Multimodal Live API, if `store_context` bool is specified, Gemini will leverage it to automatically memorize the interactions between the client and Gemini, and retrieve context when needed to augment the response generation for users' ongoing and future interactions. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, + }, + ], + "author": "A String", # Required. The ID of the agent or entity that generated this event. Use "user" to denote events generated by the end-user. + "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. + "code": "A String", # Required. The code to be executed. + "language": "A String", # Required. Programming language of the `code`. + }, + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "functionCall": { # A predicted FunctionCall returned from the model that contains a string representing the FunctionDeclaration.name and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. + "a_key": "", # Properties of the object. + }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. + "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. + "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. + { # Partial argument value of the function call. + "boolValue": True or False, # Optional. Represents a boolean value. + "jsonPath": "A String", # Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data". + "nullValue": "A String", # Optional. Represents a null value. + "numberValue": 3.14, # Optional. Represents a double value. + "stringValue": "A String", # Optional. Represents a string value. + "willContinue": True or False, # Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow. + }, + ], + "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. + }, + "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. + "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. + "a_key": "", # Properties of the object. + }, + "scheduling": "A String", # Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE. + }, + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. + "level": "A String", # The tokenization quality used for given media. + }, + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "endOffset": "A String", # Optional. The end offset of the video. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + "eventTime": "A String", # Optional. The timestamp when the event occurred. + "stateDelta": { # Optional. The change in the session state caused by this event. This is a key-value map of fields that were modified or added by the event. + "a_key": "", # Properties of the object. + }, + }, + ], + "turnId": "A String", # Optional. A unique identifier for the turn. Useful for referencing specific turns across systems. + "turnIndex": 42, # Required. The 0-based index of the turn in the conversation sequence. + }, + ], + }, + "promptTemplateData": { # Message to hold a prompt template and the values to populate the template. # Prompt template data. + "values": { # The values for fields in the prompt template. + "a_key": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. + "code": "A String", # Required. The code to be executed. + "language": "A String", # Required. Programming language of the `code`. + }, + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "functionCall": { # A predicted FunctionCall returned from the model that contains a string representing the FunctionDeclaration.name and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. + "a_key": "", # Properties of the object. + }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. + "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. + "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. + { # Partial argument value of the function call. + "boolValue": True or False, # Optional. Represents a boolean value. + "jsonPath": "A String", # Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data". + "nullValue": "A String", # Optional. Represents a null value. + "numberValue": 3.14, # Optional. Represents a double value. + "stringValue": "A String", # Optional. Represents a string value. + "willContinue": True or False, # Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow. + }, + ], + "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. + }, + "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. + "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. + "a_key": "", # Properties of the object. + }, + "scheduling": "A String", # Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE. + }, + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. + "level": "A String", # The tokenization quality used for given media. + }, + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "endOffset": "A String", # Optional. The end offset of the video. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + }, + }, + "text": "A String", # Text prompt. + "userScenario": { # User scenario to help simulate multi-turn agent running results. # Optional. The generated user scenario used to drive multi-turn agent running results. + "conversationPlan": "A String", # Required. The plan for the conversation, used to drive the multi-turn agent run and generate the simulated agent evaluation dataset. + "startingPrompt": "A String", # Required. The prompt that starts the conversation between the simulated user and the agent under test. + }, + "value": "", # Fields and values that can be used to populate the prompt template. + }, + "rubrics": { # Optional. Named groups of rubrics associated with this prompt. The key is a user-defined name for the rubric group. + "a_key": { # A group of rubrics, used for grouping rubrics based on a metric or a version. + "displayName": "A String", # Human-readable name for the group. This should be unique within a given context if used for display or selection. Example: "Instruction Following V1", "Content Quality - Summarization Task". + "groupId": "A String", # Unique identifier for the group. + "rubrics": [ # Rubrics that are part of this group. + { # Message representing a single testable criterion for evaluation. One input prompt could have multiple rubrics. + "content": { # Content of the rubric, defining the testable criteria. # Required. The actual testable criteria for the rubric. + "property": { # Defines criteria based on a specific property. # Evaluation criteria based on a specific property. + "description": "A String", # Description of the property being evaluated. Example: "The model's response is grammatically correct." + }, + }, + "importance": "A String", # Optional. The relative importance of this rubric. + "rubricId": "A String", # Unique identifier for the rubric. This ID is used to refer to this rubric, e.g., in RubricVerdict. + "type": "A String", # Optional. A type designator for the rubric, which can inform how it's evaluated or interpreted by systems or users. It's recommended to use consistent, well-defined, upper snake_case strings. Examples: "SUMMARIZATION_QUALITY", "SAFETY_HARMFUL_CONTENT", "INSTRUCTION_ADHERENCE". + }, + ], + }, + }, + }, + }, + "failedRubrics": [ # The specific rubric(s) that failed and caused this example to be classified here. An example might fail multiple rubrics, but only specific ones trigger this loss pattern. + { # Represents a specific failed rubric and the associated analysis. + "classificationRationale": "A String", # The rationale provided by the Loss Analysis Classifier for why this failure maps to this specific Loss Cluster. e.g., "The agent claimed an action without a tool call, matching 'Hallucination of Action'." + "rubricId": "A String", # The unique ID of the rubric (if available from the metric source). Clients use this ID to query the corresponding rubric verdict. + }, + ], + }, + ], + "itemCount": 42, # The total number of EvaluationItems falling into this cluster. + "taxonomyEntry": { # Defines a specific entry in the loss pattern taxonomy. # The structured definition of the loss taxonomy for this cluster. + "description": "A String", # A detailed description of this loss pattern. Example: "The agent verbally confirms an action without executing the tool." + "l1Category": "A String", # The primary category of the loss (e.g., "Hallucination", "Tool Calling"). This field is typically required. + "l2Category": "A String", # The secondary category of the loss (e.g., "Hallucination of Action", "Incorrect Tool Selection"). + }, + }, + ], + "config": { # Configuration for the loss analysis job. # The configuration used to generate this analysis. + "candidate": "A String", # Required. The candidate model/agent to analyze (e.g., "gemini-3.0-pro"). This targets the specific CandidateResult within the EvaluationResult. + "metric": "A String", # Required. The metric to analyze (e.g., "tool_use_quality"). This filters the EvaluationItems in the EvalSet to only those where EvaluationResult.metric matches this value. + }, + }, + ], "summaryMetrics": { # The summary metrics for the evaluation run. # Optional. The summary metrics for the evaluation run. "failedItems": 42, # Optional. The number of items that failed to be evaluated. "metrics": { # Optional. Map of metric name to metric value. @@ -2285,6 +4297,12 @@

Method Details

"displayName": "A String", # Optional. A display name for this custom summary metric. Used to prefix keys in the output summaryMetrics map. If not provided, a default name like "dataset_custom_metric_1", "dataset_custom_metric_2", etc., will be generated based on the order in the repeated field. }, ], + "lossAnalysisConfig": [ # Optional. Specifications for loss analysis. Each config can be specified for one metric. + { # Configuration for the loss analysis job. + "candidate": "A String", # Required. The candidate model/agent to analyze (e.g., "gemini-3.0-pro"). This targets the specific CandidateResult within the EvaluationResult. + "metric": "A String", # Required. The metric to analyze (e.g., "tool_use_quality"). This filters the EvaluationItems in the EvalSet to only those where EvaluationResult.metric matches this value. + }, + ], "metrics": [ # Required. The metrics to be calculated in the evaluation run. { # The metric used for evaluation runs. "computationBasedMetricSpec": { # Specification for a computation based metric. # Spec for a computation based metric. @@ -3306,6 +5324,2012 @@

Method Details

}, "evaluationResults": { # The results of the evaluation run. # Output only. The results of the evaluation run. Only populated when the evaluation run's state is SUCCEEDED. "evaluationSet": "A String", # The evaluation set where item level results are stored. + "lossAnalysisResults": [ # Output only. The results of the auto-loss analysis performed on the eval set associated with the run. + { # The top-level result for loss analysis, stored within an EvalSet. + "analysisTime": "A String", # The timestamp when this analysis was performed. + "clusters": [ # The list of identified loss clusters. + { # Represents a semantic grouping of failures (e.g., "Hallucination of Action"). + "clusterId": "A String", # Unique identifier for the loss cluster within the scope of the analysis result. + "examples": [ # A list of examples that belong to this cluster. This links the cluster back to the specific EvaluationItems and Rubrics. + { # Represents a specific example of a loss pattern. + "evaluationItem": "A String", # Reference to the persisted EvalItem resource name. Format: projects/.../locations/.../evaluationItems/{item_id} Used when analysis is run on an EvalSet. + "evaluationResult": { # Evaluation result. # The full evaluation result object provided inline. Used when the analysis is performed on ephemeral data (without an EvaluationSet). + "candidateResults": [ # Optional. The results for the metric. + { # Result for a single candidate. + "additionalResults": "", # Optional. Additional results for the metric. + "candidate": "A String", # Required. The candidate that is being evaluated. The value is the same as the candidate name in the EvaluationRequest. + "explanation": "A String", # Optional. The explanation for the metric. + "metric": "A String", # Required. The metric that was evaluated. + "rubricVerdicts": [ # Optional. The rubric verdicts for the metric. + { # Represents the verdict of an evaluation against a single rubric. + "evaluatedRubric": { # Message representing a single testable criterion for evaluation. One input prompt could have multiple rubrics. # Required. The full rubric definition that was evaluated. Storing this ensures the verdict is self-contained and understandable, especially if the original rubric definition changes or was dynamically generated. + "content": { # Content of the rubric, defining the testable criteria. # Required. The actual testable criteria for the rubric. + "property": { # Defines criteria based on a specific property. # Evaluation criteria based on a specific property. + "description": "A String", # Description of the property being evaluated. Example: "The model's response is grammatically correct." + }, + }, + "importance": "A String", # Optional. The relative importance of this rubric. + "rubricId": "A String", # Unique identifier for the rubric. This ID is used to refer to this rubric, e.g., in RubricVerdict. + "type": "A String", # Optional. A type designator for the rubric, which can inform how it's evaluated or interpreted by systems or users. It's recommended to use consistent, well-defined, upper snake_case strings. Examples: "SUMMARIZATION_QUALITY", "SAFETY_HARMFUL_CONTENT", "INSTRUCTION_ADHERENCE". + }, + "reasoning": "A String", # Optional. Human-readable reasoning or explanation for the verdict. This can include specific examples or details from the evaluated content that justify the given verdict. + "verdict": True or False, # Required. Outcome of the evaluation against the rubric, represented as a boolean. `true` indicates a "Pass", `false` indicates a "Fail". + }, + ], + "score": 3.14, # Optional. The score for the metric. + }, + ], + "evaluationRequest": "A String", # Required. The request item that was evaluated. Format: projects/{project}/locations/{location}/evaluationItems/{evaluation_item} + "evaluationRun": "A String", # Required. The evaluation run that was used to generate the result. Format: projects/{project}/locations/{location}/evaluationRuns/{evaluation_run} + "metadata": "", # Optional. Metadata about the evaluation result. + "metric": "A String", # Required. The metric that was evaluated. + "request": { # A single evaluation request supporting input for both single-turn model generation and multi-turn agent execution traces. Valid input modes: 1. Inference Mode: `prompt` is set (containing text or AgentData context). 2. Offline Eval Mode: `prompt` is unset, and `candidate_responses` contains `agent_data` (the completed execution trace). Validation Rule: Either `prompt` must be set, OR at least one of the `candidate_responses` must contain `agent_data`. # Required. The request that was evaluated. + "candidateResponses": [ # Optional. Responses from model under test and other baseline models for comparison. + { # Responses from model or agent. + "agentData": { # Represents data specific to multi-turn agent evaluations. # Optional. Represents the complete execution trace of a multi-turn conversation, which can involve single or multiple agents. This field is used to provide the full output of an agent's run, including all turns and events, for direct evaluation. + "agents": { # Optional. A map containing the static configurations for each agent in the system. Key: agent_id (matches the `author` field in events). Value: The static configuration of the agent. + "a_key": { # Represents configuration for an Agent. + "agentId": "A String", # Required. Unique identifier of the agent. This ID is used to refer to this agent, e.g., in AgentEvent.author, or in the `sub_agents` field. It must be unique within the `agents` map. + "agentType": "A String", # Optional. The type or class of the agent (e.g., "LlmAgent", "RouterAgent", "ToolUseAgent"). Useful for the autorater to understand the expected behavior of the agent. + "description": "A String", # Optional. A high-level description of the agent's role and responsibilities. Critical for evaluating if the agent is routing tasks correctly. + "instruction": "A String", # Optional. Provides instructions for the LLM model, guiding the agent's behavior. Can be static or dynamic. Dynamic instructions can contain placeholders like {variable_name} that will be resolved at runtime using the `AgentEvent.state_delta` field. + "subAgents": [ # Optional. The list of valid agent IDs that this agent can delegate to. This defines the directed edges in the multi-agent system graph topology. + "A String", + ], + "tools": [ # Optional. The list of tools available to this agent. + { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. + }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, + "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. + "A String", + ], + }, + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. + "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1beta1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. + "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1beta1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. + }, + ], + "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. If true, include the widget context token in the response. + }, + "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. + "A String", + ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, + }, + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. + "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. + "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. + "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. + }, + }, + "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation + "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more details. + "customConfigs": { # Optional. Custom configs for ParallelAiSearch. This field can be used to pass any parameter from the Parallel.ai Search API. See the Parallel.ai documentation for the full list of available parameters and their usage: https://docs.parallel.ai/api-reference/search-beta/search Currently only `source_policy`, `excerpts`, `max_results`, `mode`, `fetch_policy` can be set via this field. For example: { "source_policy": { "include_domains": ["google.com", "wikipedia.org"], "exclude_domains": ["example.com"] }, "fetch_policy": { "max_age_seconds": 3600 } } + "a_key": "", # Properties of the object. + }, + }, + "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. + "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported. + "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. + "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. + }, + }, + "apiSpec": "A String", # The API spec that the external API implements. + "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. + "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. + "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + "apiKeyString": "A String", # Optional. The API key to be used in the request directly. + "httpElementLocation": "A String", # Optional. The location of the API key. + "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + }, + "authType": "A String", # Type of auth scheme. + "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. + "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + }, + "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. + "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + }, + "oauthConfig": { # Config for user oauth. # Config for user oauth. + "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + }, + "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. + "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + }, + }, + "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. + "index": "A String", # The ElasticSearch index to use. + "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. + "searchTemplate": "A String", # The ElasticSearch search template to use. + }, + "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search + "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. + }, + }, + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. + { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec + "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + ], + "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + "filter": "A String", # Optional. Filter strings to be passed to the search API. + "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. + }, + "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. + "ragCorpora": [ # Optional. Deprecated. Please use rag_resources instead. + "A String", + ], + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "hybridSearch": { # Config for Hybrid Search. # Optional. Config for Hybrid Search. + "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. The range is [0, 1], while 0 means sparse vector search only and 1 means dense vector search only. The default value is 0.5 which balances sparse and dense vector search equally. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. + "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + }, + "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` + }, + }, + "topK": 42, # Optional. The number of contexts to retrieve. + }, + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "storeContext": True or False, # Optional. Currently only supported for Gemini Multimodal Live API. In Gemini Multimodal Live API, if `store_context` bool is specified, Gemini will leverage it to automatically memorize the interactions between the client and Gemini, and retrieve context when needed to augment the response generation for users' ongoing and future interactions. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, + }, + ], + }, + }, + "turns": [ # Optional. A chronological list of conversation turns. Each turn represents a logical execution cycle (e.g., User Input -> Agent Response). + { # Represents a single turn/invocation in the conversation. + "events": [ # Optional. The list of events that occurred during this turn. + { # Represents a single event in the execution trace. + "activeTools": [ # Optional. The list of tools that were active/available to the agent at the time of this event. This overrides the `AgentConfig.tools` if set. + { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. + }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, + "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. + "A String", + ], + }, + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. + "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1beta1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. + "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1beta1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. + }, + ], + "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. If true, include the widget context token in the response. + }, + "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. + "A String", + ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, + }, + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. + "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. + "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. + "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. + }, + }, + "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation + "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more details. + "customConfigs": { # Optional. Custom configs for ParallelAiSearch. This field can be used to pass any parameter from the Parallel.ai Search API. See the Parallel.ai documentation for the full list of available parameters and their usage: https://docs.parallel.ai/api-reference/search-beta/search Currently only `source_policy`, `excerpts`, `max_results`, `mode`, `fetch_policy` can be set via this field. For example: { "source_policy": { "include_domains": ["google.com", "wikipedia.org"], "exclude_domains": ["example.com"] }, "fetch_policy": { "max_age_seconds": 3600 } } + "a_key": "", # Properties of the object. + }, + }, + "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. + "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported. + "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. + "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. + }, + }, + "apiSpec": "A String", # The API spec that the external API implements. + "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. + "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. + "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + "apiKeyString": "A String", # Optional. The API key to be used in the request directly. + "httpElementLocation": "A String", # Optional. The location of the API key. + "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + }, + "authType": "A String", # Type of auth scheme. + "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. + "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + }, + "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. + "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + }, + "oauthConfig": { # Config for user oauth. # Config for user oauth. + "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + }, + "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. + "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + }, + }, + "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. + "index": "A String", # The ElasticSearch index to use. + "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. + "searchTemplate": "A String", # The ElasticSearch search template to use. + }, + "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search + "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. + }, + }, + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. + { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec + "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + ], + "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + "filter": "A String", # Optional. Filter strings to be passed to the search API. + "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. + }, + "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. + "ragCorpora": [ # Optional. Deprecated. Please use rag_resources instead. + "A String", + ], + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "hybridSearch": { # Config for Hybrid Search. # Optional. Config for Hybrid Search. + "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. The range is [0, 1], while 0 means sparse vector search only and 1 means dense vector search only. The default value is 0.5 which balances sparse and dense vector search equally. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. + "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + }, + "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` + }, + }, + "topK": 42, # Optional. The number of contexts to retrieve. + }, + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "storeContext": True or False, # Optional. Currently only supported for Gemini Multimodal Live API. In Gemini Multimodal Live API, if `store_context` bool is specified, Gemini will leverage it to automatically memorize the interactions between the client and Gemini, and retrieve context when needed to augment the response generation for users' ongoing and future interactions. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, + }, + ], + "author": "A String", # Required. The ID of the agent or entity that generated this event. Use "user" to denote events generated by the end-user. + "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. + "code": "A String", # Required. The code to be executed. + "language": "A String", # Required. Programming language of the `code`. + }, + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "functionCall": { # A predicted FunctionCall returned from the model that contains a string representing the FunctionDeclaration.name and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. + "a_key": "", # Properties of the object. + }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. + "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. + "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. + { # Partial argument value of the function call. + "boolValue": True or False, # Optional. Represents a boolean value. + "jsonPath": "A String", # Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data". + "nullValue": "A String", # Optional. Represents a null value. + "numberValue": 3.14, # Optional. Represents a double value. + "stringValue": "A String", # Optional. Represents a string value. + "willContinue": True or False, # Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow. + }, + ], + "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. + }, + "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. + "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. + "a_key": "", # Properties of the object. + }, + "scheduling": "A String", # Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE. + }, + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. + "level": "A String", # The tokenization quality used for given media. + }, + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "endOffset": "A String", # Optional. The end offset of the video. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + "eventTime": "A String", # Optional. The timestamp when the event occurred. + "stateDelta": { # Optional. The change in the session state caused by this event. This is a key-value map of fields that were modified or added by the event. + "a_key": "", # Properties of the object. + }, + }, + ], + "turnId": "A String", # Optional. A unique identifier for the turn. Useful for referencing specific turns across systems. + "turnIndex": 42, # Required. The 0-based index of the turn in the conversation sequence. + }, + ], + }, + "candidate": "A String", # Required. The name of the candidate that produced the response. + "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). # Output only. Error while scraping model or agent. + "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. + }, + "events": [ # Optional. Intermediate events (such as tool calls and responses) that led to the final response. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. + "code": "A String", # Required. The code to be executed. + "language": "A String", # Required. Programming language of the `code`. + }, + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "functionCall": { # A predicted FunctionCall returned from the model that contains a string representing the FunctionDeclaration.name and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. + "a_key": "", # Properties of the object. + }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. + "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. + "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. + { # Partial argument value of the function call. + "boolValue": True or False, # Optional. Represents a boolean value. + "jsonPath": "A String", # Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data". + "nullValue": "A String", # Optional. Represents a null value. + "numberValue": 3.14, # Optional. Represents a double value. + "stringValue": "A String", # Optional. Represents a string value. + "willContinue": True or False, # Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow. + }, + ], + "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. + }, + "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. + "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. + "a_key": "", # Properties of the object. + }, + "scheduling": "A String", # Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE. + }, + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. + "level": "A String", # The tokenization quality used for given media. + }, + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "endOffset": "A String", # Optional. The end offset of the video. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + ], + "text": "A String", # Text response. + "value": "", # Fields and values that can be used to populate the response template. + }, + ], + "goldenResponse": { # Responses from model or agent. # Optional. The Ideal response or ground truth. + "agentData": { # Represents data specific to multi-turn agent evaluations. # Optional. Represents the complete execution trace of a multi-turn conversation, which can involve single or multiple agents. This field is used to provide the full output of an agent's run, including all turns and events, for direct evaluation. + "agents": { # Optional. A map containing the static configurations for each agent in the system. Key: agent_id (matches the `author` field in events). Value: The static configuration of the agent. + "a_key": { # Represents configuration for an Agent. + "agentId": "A String", # Required. Unique identifier of the agent. This ID is used to refer to this agent, e.g., in AgentEvent.author, or in the `sub_agents` field. It must be unique within the `agents` map. + "agentType": "A String", # Optional. The type or class of the agent (e.g., "LlmAgent", "RouterAgent", "ToolUseAgent"). Useful for the autorater to understand the expected behavior of the agent. + "description": "A String", # Optional. A high-level description of the agent's role and responsibilities. Critical for evaluating if the agent is routing tasks correctly. + "instruction": "A String", # Optional. Provides instructions for the LLM model, guiding the agent's behavior. Can be static or dynamic. Dynamic instructions can contain placeholders like {variable_name} that will be resolved at runtime using the `AgentEvent.state_delta` field. + "subAgents": [ # Optional. The list of valid agent IDs that this agent can delegate to. This defines the directed edges in the multi-agent system graph topology. + "A String", + ], + "tools": [ # Optional. The list of tools available to this agent. + { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. + }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, + "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. + "A String", + ], + }, + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. + "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1beta1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. + "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1beta1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. + }, + ], + "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. If true, include the widget context token in the response. + }, + "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. + "A String", + ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, + }, + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. + "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. + "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. + "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. + }, + }, + "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation + "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more details. + "customConfigs": { # Optional. Custom configs for ParallelAiSearch. This field can be used to pass any parameter from the Parallel.ai Search API. See the Parallel.ai documentation for the full list of available parameters and their usage: https://docs.parallel.ai/api-reference/search-beta/search Currently only `source_policy`, `excerpts`, `max_results`, `mode`, `fetch_policy` can be set via this field. For example: { "source_policy": { "include_domains": ["google.com", "wikipedia.org"], "exclude_domains": ["example.com"] }, "fetch_policy": { "max_age_seconds": 3600 } } + "a_key": "", # Properties of the object. + }, + }, + "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. + "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported. + "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. + "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. + }, + }, + "apiSpec": "A String", # The API spec that the external API implements. + "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. + "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. + "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + "apiKeyString": "A String", # Optional. The API key to be used in the request directly. + "httpElementLocation": "A String", # Optional. The location of the API key. + "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + }, + "authType": "A String", # Type of auth scheme. + "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. + "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + }, + "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. + "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + }, + "oauthConfig": { # Config for user oauth. # Config for user oauth. + "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + }, + "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. + "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + }, + }, + "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. + "index": "A String", # The ElasticSearch index to use. + "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. + "searchTemplate": "A String", # The ElasticSearch search template to use. + }, + "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search + "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. + }, + }, + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. + { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec + "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + ], + "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + "filter": "A String", # Optional. Filter strings to be passed to the search API. + "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. + }, + "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. + "ragCorpora": [ # Optional. Deprecated. Please use rag_resources instead. + "A String", + ], + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "hybridSearch": { # Config for Hybrid Search. # Optional. Config for Hybrid Search. + "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. The range is [0, 1], while 0 means sparse vector search only and 1 means dense vector search only. The default value is 0.5 which balances sparse and dense vector search equally. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. + "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + }, + "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` + }, + }, + "topK": 42, # Optional. The number of contexts to retrieve. + }, + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "storeContext": True or False, # Optional. Currently only supported for Gemini Multimodal Live API. In Gemini Multimodal Live API, if `store_context` bool is specified, Gemini will leverage it to automatically memorize the interactions between the client and Gemini, and retrieve context when needed to augment the response generation for users' ongoing and future interactions. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, + }, + ], + }, + }, + "turns": [ # Optional. A chronological list of conversation turns. Each turn represents a logical execution cycle (e.g., User Input -> Agent Response). + { # Represents a single turn/invocation in the conversation. + "events": [ # Optional. The list of events that occurred during this turn. + { # Represents a single event in the execution trace. + "activeTools": [ # Optional. The list of tools that were active/available to the agent at the time of this event. This overrides the `AgentConfig.tools` if set. + { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. + }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, + "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. + "A String", + ], + }, + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. + "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1beta1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. + "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1beta1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. + }, + ], + "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. If true, include the widget context token in the response. + }, + "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. + "A String", + ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, + }, + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. + "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. + "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. + "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. + }, + }, + "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation + "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more details. + "customConfigs": { # Optional. Custom configs for ParallelAiSearch. This field can be used to pass any parameter from the Parallel.ai Search API. See the Parallel.ai documentation for the full list of available parameters and their usage: https://docs.parallel.ai/api-reference/search-beta/search Currently only `source_policy`, `excerpts`, `max_results`, `mode`, `fetch_policy` can be set via this field. For example: { "source_policy": { "include_domains": ["google.com", "wikipedia.org"], "exclude_domains": ["example.com"] }, "fetch_policy": { "max_age_seconds": 3600 } } + "a_key": "", # Properties of the object. + }, + }, + "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. + "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported. + "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. + "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. + }, + }, + "apiSpec": "A String", # The API spec that the external API implements. + "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. + "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. + "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + "apiKeyString": "A String", # Optional. The API key to be used in the request directly. + "httpElementLocation": "A String", # Optional. The location of the API key. + "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + }, + "authType": "A String", # Type of auth scheme. + "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. + "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + }, + "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. + "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + }, + "oauthConfig": { # Config for user oauth. # Config for user oauth. + "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + }, + "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. + "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + }, + }, + "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. + "index": "A String", # The ElasticSearch index to use. + "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. + "searchTemplate": "A String", # The ElasticSearch search template to use. + }, + "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search + "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. + }, + }, + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. + { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec + "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + ], + "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + "filter": "A String", # Optional. Filter strings to be passed to the search API. + "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. + }, + "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. + "ragCorpora": [ # Optional. Deprecated. Please use rag_resources instead. + "A String", + ], + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "hybridSearch": { # Config for Hybrid Search. # Optional. Config for Hybrid Search. + "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. The range is [0, 1], while 0 means sparse vector search only and 1 means dense vector search only. The default value is 0.5 which balances sparse and dense vector search equally. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. + "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + }, + "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` + }, + }, + "topK": 42, # Optional. The number of contexts to retrieve. + }, + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "storeContext": True or False, # Optional. Currently only supported for Gemini Multimodal Live API. In Gemini Multimodal Live API, if `store_context` bool is specified, Gemini will leverage it to automatically memorize the interactions between the client and Gemini, and retrieve context when needed to augment the response generation for users' ongoing and future interactions. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, + }, + ], + "author": "A String", # Required. The ID of the agent or entity that generated this event. Use "user" to denote events generated by the end-user. + "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. + "code": "A String", # Required. The code to be executed. + "language": "A String", # Required. Programming language of the `code`. + }, + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "functionCall": { # A predicted FunctionCall returned from the model that contains a string representing the FunctionDeclaration.name and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. + "a_key": "", # Properties of the object. + }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. + "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. + "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. + { # Partial argument value of the function call. + "boolValue": True or False, # Optional. Represents a boolean value. + "jsonPath": "A String", # Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data". + "nullValue": "A String", # Optional. Represents a null value. + "numberValue": 3.14, # Optional. Represents a double value. + "stringValue": "A String", # Optional. Represents a string value. + "willContinue": True or False, # Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow. + }, + ], + "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. + }, + "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. + "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. + "a_key": "", # Properties of the object. + }, + "scheduling": "A String", # Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE. + }, + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. + "level": "A String", # The tokenization quality used for given media. + }, + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "endOffset": "A String", # Optional. The end offset of the video. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + "eventTime": "A String", # Optional. The timestamp when the event occurred. + "stateDelta": { # Optional. The change in the session state caused by this event. This is a key-value map of fields that were modified or added by the event. + "a_key": "", # Properties of the object. + }, + }, + ], + "turnId": "A String", # Optional. A unique identifier for the turn. Useful for referencing specific turns across systems. + "turnIndex": 42, # Required. The 0-based index of the turn in the conversation sequence. + }, + ], + }, + "candidate": "A String", # Required. The name of the candidate that produced the response. + "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). # Output only. Error while scraping model or agent. + "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. + }, + "events": [ # Optional. Intermediate events (such as tool calls and responses) that led to the final response. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. + "code": "A String", # Required. The code to be executed. + "language": "A String", # Required. Programming language of the `code`. + }, + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "functionCall": { # A predicted FunctionCall returned from the model that contains a string representing the FunctionDeclaration.name and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. + "a_key": "", # Properties of the object. + }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. + "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. + "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. + { # Partial argument value of the function call. + "boolValue": True or False, # Optional. Represents a boolean value. + "jsonPath": "A String", # Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data". + "nullValue": "A String", # Optional. Represents a null value. + "numberValue": 3.14, # Optional. Represents a double value. + "stringValue": "A String", # Optional. Represents a string value. + "willContinue": True or False, # Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow. + }, + ], + "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. + }, + "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. + "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. + "a_key": "", # Properties of the object. + }, + "scheduling": "A String", # Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE. + }, + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. + "level": "A String", # The tokenization quality used for given media. + }, + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "endOffset": "A String", # Optional. The end offset of the video. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + ], + "text": "A String", # Text response. + "value": "", # Fields and values that can be used to populate the response template. + }, + "prompt": { # Prompt to be evaluated. This can represent a single-turn prompt or a multi-turn conversation for agent evaluations. # Optional. The request/prompt to evaluate. + "agentData": { # Represents data specific to multi-turn agent evaluations. # Optional. Represents the complete execution trace of a multi-turn conversation, which can involve single or multiple agents. This serves as the input context for agent scraping. + "agents": { # Optional. A map containing the static configurations for each agent in the system. Key: agent_id (matches the `author` field in events). Value: The static configuration of the agent. + "a_key": { # Represents configuration for an Agent. + "agentId": "A String", # Required. Unique identifier of the agent. This ID is used to refer to this agent, e.g., in AgentEvent.author, or in the `sub_agents` field. It must be unique within the `agents` map. + "agentType": "A String", # Optional. The type or class of the agent (e.g., "LlmAgent", "RouterAgent", "ToolUseAgent"). Useful for the autorater to understand the expected behavior of the agent. + "description": "A String", # Optional. A high-level description of the agent's role and responsibilities. Critical for evaluating if the agent is routing tasks correctly. + "instruction": "A String", # Optional. Provides instructions for the LLM model, guiding the agent's behavior. Can be static or dynamic. Dynamic instructions can contain placeholders like {variable_name} that will be resolved at runtime using the `AgentEvent.state_delta` field. + "subAgents": [ # Optional. The list of valid agent IDs that this agent can delegate to. This defines the directed edges in the multi-agent system graph topology. + "A String", + ], + "tools": [ # Optional. The list of tools available to this agent. + { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. + }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, + "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. + "A String", + ], + }, + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. + "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1beta1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. + "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1beta1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. + }, + ], + "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. If true, include the widget context token in the response. + }, + "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. + "A String", + ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, + }, + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. + "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. + "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. + "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. + }, + }, + "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation + "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more details. + "customConfigs": { # Optional. Custom configs for ParallelAiSearch. This field can be used to pass any parameter from the Parallel.ai Search API. See the Parallel.ai documentation for the full list of available parameters and their usage: https://docs.parallel.ai/api-reference/search-beta/search Currently only `source_policy`, `excerpts`, `max_results`, `mode`, `fetch_policy` can be set via this field. For example: { "source_policy": { "include_domains": ["google.com", "wikipedia.org"], "exclude_domains": ["example.com"] }, "fetch_policy": { "max_age_seconds": 3600 } } + "a_key": "", # Properties of the object. + }, + }, + "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. + "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported. + "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. + "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. + }, + }, + "apiSpec": "A String", # The API spec that the external API implements. + "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. + "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. + "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + "apiKeyString": "A String", # Optional. The API key to be used in the request directly. + "httpElementLocation": "A String", # Optional. The location of the API key. + "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + }, + "authType": "A String", # Type of auth scheme. + "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. + "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + }, + "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. + "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + }, + "oauthConfig": { # Config for user oauth. # Config for user oauth. + "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + }, + "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. + "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + }, + }, + "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. + "index": "A String", # The ElasticSearch index to use. + "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. + "searchTemplate": "A String", # The ElasticSearch search template to use. + }, + "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search + "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. + }, + }, + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. + { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec + "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + ], + "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + "filter": "A String", # Optional. Filter strings to be passed to the search API. + "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. + }, + "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. + "ragCorpora": [ # Optional. Deprecated. Please use rag_resources instead. + "A String", + ], + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "hybridSearch": { # Config for Hybrid Search. # Optional. Config for Hybrid Search. + "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. The range is [0, 1], while 0 means sparse vector search only and 1 means dense vector search only. The default value is 0.5 which balances sparse and dense vector search equally. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. + "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + }, + "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` + }, + }, + "topK": 42, # Optional. The number of contexts to retrieve. + }, + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "storeContext": True or False, # Optional. Currently only supported for Gemini Multimodal Live API. In Gemini Multimodal Live API, if `store_context` bool is specified, Gemini will leverage it to automatically memorize the interactions between the client and Gemini, and retrieve context when needed to augment the response generation for users' ongoing and future interactions. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, + }, + ], + }, + }, + "turns": [ # Optional. A chronological list of conversation turns. Each turn represents a logical execution cycle (e.g., User Input -> Agent Response). + { # Represents a single turn/invocation in the conversation. + "events": [ # Optional. The list of events that occurred during this turn. + { # Represents a single event in the execution trace. + "activeTools": [ # Optional. The list of tools that were active/available to the agent at the time of this event. This overrides the `AgentConfig.tools` if set. + { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. + }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, + "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. + "A String", + ], + }, + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. + "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1beta1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. + "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1beta1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. + }, + ], + "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. If true, include the widget context token in the response. + }, + "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. + "A String", + ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, + }, + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. + "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. + "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. + "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. + }, + }, + "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation + "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more details. + "customConfigs": { # Optional. Custom configs for ParallelAiSearch. This field can be used to pass any parameter from the Parallel.ai Search API. See the Parallel.ai documentation for the full list of available parameters and their usage: https://docs.parallel.ai/api-reference/search-beta/search Currently only `source_policy`, `excerpts`, `max_results`, `mode`, `fetch_policy` can be set via this field. For example: { "source_policy": { "include_domains": ["google.com", "wikipedia.org"], "exclude_domains": ["example.com"] }, "fetch_policy": { "max_age_seconds": 3600 } } + "a_key": "", # Properties of the object. + }, + }, + "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. + "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported. + "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. + "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. + }, + }, + "apiSpec": "A String", # The API spec that the external API implements. + "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. + "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. + "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + "apiKeyString": "A String", # Optional. The API key to be used in the request directly. + "httpElementLocation": "A String", # Optional. The location of the API key. + "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + }, + "authType": "A String", # Type of auth scheme. + "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. + "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + }, + "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. + "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + }, + "oauthConfig": { # Config for user oauth. # Config for user oauth. + "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + }, + "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. + "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + }, + }, + "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. + "index": "A String", # The ElasticSearch index to use. + "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. + "searchTemplate": "A String", # The ElasticSearch search template to use. + }, + "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search + "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. + }, + }, + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. + { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec + "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + ], + "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + "filter": "A String", # Optional. Filter strings to be passed to the search API. + "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. + }, + "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. + "ragCorpora": [ # Optional. Deprecated. Please use rag_resources instead. + "A String", + ], + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "hybridSearch": { # Config for Hybrid Search. # Optional. Config for Hybrid Search. + "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. The range is [0, 1], while 0 means sparse vector search only and 1 means dense vector search only. The default value is 0.5 which balances sparse and dense vector search equally. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. + "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + }, + "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` + }, + }, + "topK": 42, # Optional. The number of contexts to retrieve. + }, + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "storeContext": True or False, # Optional. Currently only supported for Gemini Multimodal Live API. In Gemini Multimodal Live API, if `store_context` bool is specified, Gemini will leverage it to automatically memorize the interactions between the client and Gemini, and retrieve context when needed to augment the response generation for users' ongoing and future interactions. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, + }, + ], + "author": "A String", # Required. The ID of the agent or entity that generated this event. Use "user" to denote events generated by the end-user. + "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. + "code": "A String", # Required. The code to be executed. + "language": "A String", # Required. Programming language of the `code`. + }, + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "functionCall": { # A predicted FunctionCall returned from the model that contains a string representing the FunctionDeclaration.name and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. + "a_key": "", # Properties of the object. + }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. + "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. + "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. + { # Partial argument value of the function call. + "boolValue": True or False, # Optional. Represents a boolean value. + "jsonPath": "A String", # Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data". + "nullValue": "A String", # Optional. Represents a null value. + "numberValue": 3.14, # Optional. Represents a double value. + "stringValue": "A String", # Optional. Represents a string value. + "willContinue": True or False, # Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow. + }, + ], + "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. + }, + "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. + "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. + "a_key": "", # Properties of the object. + }, + "scheduling": "A String", # Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE. + }, + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. + "level": "A String", # The tokenization quality used for given media. + }, + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "endOffset": "A String", # Optional. The end offset of the video. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + "eventTime": "A String", # Optional. The timestamp when the event occurred. + "stateDelta": { # Optional. The change in the session state caused by this event. This is a key-value map of fields that were modified or added by the event. + "a_key": "", # Properties of the object. + }, + }, + ], + "turnId": "A String", # Optional. A unique identifier for the turn. Useful for referencing specific turns across systems. + "turnIndex": 42, # Required. The 0-based index of the turn in the conversation sequence. + }, + ], + }, + "promptTemplateData": { # Message to hold a prompt template and the values to populate the template. # Prompt template data. + "values": { # The values for fields in the prompt template. + "a_key": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. + "code": "A String", # Required. The code to be executed. + "language": "A String", # Required. Programming language of the `code`. + }, + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "functionCall": { # A predicted FunctionCall returned from the model that contains a string representing the FunctionDeclaration.name and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. + "a_key": "", # Properties of the object. + }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. + "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. + "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. + { # Partial argument value of the function call. + "boolValue": True or False, # Optional. Represents a boolean value. + "jsonPath": "A String", # Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data". + "nullValue": "A String", # Optional. Represents a null value. + "numberValue": 3.14, # Optional. Represents a double value. + "stringValue": "A String", # Optional. Represents a string value. + "willContinue": True or False, # Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow. + }, + ], + "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. + }, + "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. + "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. + "a_key": "", # Properties of the object. + }, + "scheduling": "A String", # Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE. + }, + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. + "level": "A String", # The tokenization quality used for given media. + }, + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "endOffset": "A String", # Optional. The end offset of the video. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + }, + }, + "text": "A String", # Text prompt. + "userScenario": { # User scenario to help simulate multi-turn agent running results. # Optional. The generated user scenario used to drive multi-turn agent running results. + "conversationPlan": "A String", # Required. The plan for the conversation, used to drive the multi-turn agent run and generate the simulated agent evaluation dataset. + "startingPrompt": "A String", # Required. The prompt that starts the conversation between the simulated user and the agent under test. + }, + "value": "", # Fields and values that can be used to populate the prompt template. + }, + "rubrics": { # Optional. Named groups of rubrics associated with this prompt. The key is a user-defined name for the rubric group. + "a_key": { # A group of rubrics, used for grouping rubrics based on a metric or a version. + "displayName": "A String", # Human-readable name for the group. This should be unique within a given context if used for display or selection. Example: "Instruction Following V1", "Content Quality - Summarization Task". + "groupId": "A String", # Unique identifier for the group. + "rubrics": [ # Rubrics that are part of this group. + { # Message representing a single testable criterion for evaluation. One input prompt could have multiple rubrics. + "content": { # Content of the rubric, defining the testable criteria. # Required. The actual testable criteria for the rubric. + "property": { # Defines criteria based on a specific property. # Evaluation criteria based on a specific property. + "description": "A String", # Description of the property being evaluated. Example: "The model's response is grammatically correct." + }, + }, + "importance": "A String", # Optional. The relative importance of this rubric. + "rubricId": "A String", # Unique identifier for the rubric. This ID is used to refer to this rubric, e.g., in RubricVerdict. + "type": "A String", # Optional. A type designator for the rubric, which can inform how it's evaluated or interpreted by systems or users. It's recommended to use consistent, well-defined, upper snake_case strings. Examples: "SUMMARIZATION_QUALITY", "SAFETY_HARMFUL_CONTENT", "INSTRUCTION_ADHERENCE". + }, + ], + }, + }, + }, + }, + "failedRubrics": [ # The specific rubric(s) that failed and caused this example to be classified here. An example might fail multiple rubrics, but only specific ones trigger this loss pattern. + { # Represents a specific failed rubric and the associated analysis. + "classificationRationale": "A String", # The rationale provided by the Loss Analysis Classifier for why this failure maps to this specific Loss Cluster. e.g., "The agent claimed an action without a tool call, matching 'Hallucination of Action'." + "rubricId": "A String", # The unique ID of the rubric (if available from the metric source). Clients use this ID to query the corresponding rubric verdict. + }, + ], + }, + ], + "itemCount": 42, # The total number of EvaluationItems falling into this cluster. + "taxonomyEntry": { # Defines a specific entry in the loss pattern taxonomy. # The structured definition of the loss taxonomy for this cluster. + "description": "A String", # A detailed description of this loss pattern. Example: "The agent verbally confirms an action without executing the tool." + "l1Category": "A String", # The primary category of the loss (e.g., "Hallucination", "Tool Calling"). This field is typically required. + "l2Category": "A String", # The secondary category of the loss (e.g., "Hallucination of Action", "Incorrect Tool Selection"). + }, + }, + ], + "config": { # Configuration for the loss analysis job. # The configuration used to generate this analysis. + "candidate": "A String", # Required. The candidate model/agent to analyze (e.g., "gemini-3.0-pro"). This targets the specific CandidateResult within the EvaluationResult. + "metric": "A String", # Required. The metric to analyze (e.g., "tool_use_quality"). This filters the EvaluationItems in the EvalSet to only those where EvaluationResult.metric matches this value. + }, + }, + ], "summaryMetrics": { # The summary metrics for the evaluation run. # Optional. The summary metrics for the evaluation run. "failedItems": 42, # Optional. The number of items that failed to be evaluated. "metrics": { # Optional. Map of metric name to metric value. @@ -4317,6 +8341,12 @@

Method Details

"displayName": "A String", # Optional. A display name for this custom summary metric. Used to prefix keys in the output summaryMetrics map. If not provided, a default name like "dataset_custom_metric_1", "dataset_custom_metric_2", etc., will be generated based on the order in the repeated field. }, ], + "lossAnalysisConfig": [ # Optional. Specifications for loss analysis. Each config can be specified for one metric. + { # Configuration for the loss analysis job. + "candidate": "A String", # Required. The candidate model/agent to analyze (e.g., "gemini-3.0-pro"). This targets the specific CandidateResult within the EvaluationResult. + "metric": "A String", # Required. The metric to analyze (e.g., "tool_use_quality"). This filters the EvaluationItems in the EvalSet to only those where EvaluationResult.metric matches this value. + }, + ], "metrics": [ # Required. The metrics to be calculated in the evaluation run. { # The metric used for evaluation runs. "computationBasedMetricSpec": { # Specification for a computation based metric. # Spec for a computation based metric. @@ -5338,6 +9368,2012 @@

Method Details

}, "evaluationResults": { # The results of the evaluation run. # Output only. The results of the evaluation run. Only populated when the evaluation run's state is SUCCEEDED. "evaluationSet": "A String", # The evaluation set where item level results are stored. + "lossAnalysisResults": [ # Output only. The results of the auto-loss analysis performed on the eval set associated with the run. + { # The top-level result for loss analysis, stored within an EvalSet. + "analysisTime": "A String", # The timestamp when this analysis was performed. + "clusters": [ # The list of identified loss clusters. + { # Represents a semantic grouping of failures (e.g., "Hallucination of Action"). + "clusterId": "A String", # Unique identifier for the loss cluster within the scope of the analysis result. + "examples": [ # A list of examples that belong to this cluster. This links the cluster back to the specific EvaluationItems and Rubrics. + { # Represents a specific example of a loss pattern. + "evaluationItem": "A String", # Reference to the persisted EvalItem resource name. Format: projects/.../locations/.../evaluationItems/{item_id} Used when analysis is run on an EvalSet. + "evaluationResult": { # Evaluation result. # The full evaluation result object provided inline. Used when the analysis is performed on ephemeral data (without an EvaluationSet). + "candidateResults": [ # Optional. The results for the metric. + { # Result for a single candidate. + "additionalResults": "", # Optional. Additional results for the metric. + "candidate": "A String", # Required. The candidate that is being evaluated. The value is the same as the candidate name in the EvaluationRequest. + "explanation": "A String", # Optional. The explanation for the metric. + "metric": "A String", # Required. The metric that was evaluated. + "rubricVerdicts": [ # Optional. The rubric verdicts for the metric. + { # Represents the verdict of an evaluation against a single rubric. + "evaluatedRubric": { # Message representing a single testable criterion for evaluation. One input prompt could have multiple rubrics. # Required. The full rubric definition that was evaluated. Storing this ensures the verdict is self-contained and understandable, especially if the original rubric definition changes or was dynamically generated. + "content": { # Content of the rubric, defining the testable criteria. # Required. The actual testable criteria for the rubric. + "property": { # Defines criteria based on a specific property. # Evaluation criteria based on a specific property. + "description": "A String", # Description of the property being evaluated. Example: "The model's response is grammatically correct." + }, + }, + "importance": "A String", # Optional. The relative importance of this rubric. + "rubricId": "A String", # Unique identifier for the rubric. This ID is used to refer to this rubric, e.g., in RubricVerdict. + "type": "A String", # Optional. A type designator for the rubric, which can inform how it's evaluated or interpreted by systems or users. It's recommended to use consistent, well-defined, upper snake_case strings. Examples: "SUMMARIZATION_QUALITY", "SAFETY_HARMFUL_CONTENT", "INSTRUCTION_ADHERENCE". + }, + "reasoning": "A String", # Optional. Human-readable reasoning or explanation for the verdict. This can include specific examples or details from the evaluated content that justify the given verdict. + "verdict": True or False, # Required. Outcome of the evaluation against the rubric, represented as a boolean. `true` indicates a "Pass", `false` indicates a "Fail". + }, + ], + "score": 3.14, # Optional. The score for the metric. + }, + ], + "evaluationRequest": "A String", # Required. The request item that was evaluated. Format: projects/{project}/locations/{location}/evaluationItems/{evaluation_item} + "evaluationRun": "A String", # Required. The evaluation run that was used to generate the result. Format: projects/{project}/locations/{location}/evaluationRuns/{evaluation_run} + "metadata": "", # Optional. Metadata about the evaluation result. + "metric": "A String", # Required. The metric that was evaluated. + "request": { # A single evaluation request supporting input for both single-turn model generation and multi-turn agent execution traces. Valid input modes: 1. Inference Mode: `prompt` is set (containing text or AgentData context). 2. Offline Eval Mode: `prompt` is unset, and `candidate_responses` contains `agent_data` (the completed execution trace). Validation Rule: Either `prompt` must be set, OR at least one of the `candidate_responses` must contain `agent_data`. # Required. The request that was evaluated. + "candidateResponses": [ # Optional. Responses from model under test and other baseline models for comparison. + { # Responses from model or agent. + "agentData": { # Represents data specific to multi-turn agent evaluations. # Optional. Represents the complete execution trace of a multi-turn conversation, which can involve single or multiple agents. This field is used to provide the full output of an agent's run, including all turns and events, for direct evaluation. + "agents": { # Optional. A map containing the static configurations for each agent in the system. Key: agent_id (matches the `author` field in events). Value: The static configuration of the agent. + "a_key": { # Represents configuration for an Agent. + "agentId": "A String", # Required. Unique identifier of the agent. This ID is used to refer to this agent, e.g., in AgentEvent.author, or in the `sub_agents` field. It must be unique within the `agents` map. + "agentType": "A String", # Optional. The type or class of the agent (e.g., "LlmAgent", "RouterAgent", "ToolUseAgent"). Useful for the autorater to understand the expected behavior of the agent. + "description": "A String", # Optional. A high-level description of the agent's role and responsibilities. Critical for evaluating if the agent is routing tasks correctly. + "instruction": "A String", # Optional. Provides instructions for the LLM model, guiding the agent's behavior. Can be static or dynamic. Dynamic instructions can contain placeholders like {variable_name} that will be resolved at runtime using the `AgentEvent.state_delta` field. + "subAgents": [ # Optional. The list of valid agent IDs that this agent can delegate to. This defines the directed edges in the multi-agent system graph topology. + "A String", + ], + "tools": [ # Optional. The list of tools available to this agent. + { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. + }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, + "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. + "A String", + ], + }, + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. + "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1beta1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. + "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1beta1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. + }, + ], + "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. If true, include the widget context token in the response. + }, + "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. + "A String", + ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, + }, + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. + "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. + "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. + "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. + }, + }, + "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation + "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more details. + "customConfigs": { # Optional. Custom configs for ParallelAiSearch. This field can be used to pass any parameter from the Parallel.ai Search API. See the Parallel.ai documentation for the full list of available parameters and their usage: https://docs.parallel.ai/api-reference/search-beta/search Currently only `source_policy`, `excerpts`, `max_results`, `mode`, `fetch_policy` can be set via this field. For example: { "source_policy": { "include_domains": ["google.com", "wikipedia.org"], "exclude_domains": ["example.com"] }, "fetch_policy": { "max_age_seconds": 3600 } } + "a_key": "", # Properties of the object. + }, + }, + "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. + "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported. + "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. + "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. + }, + }, + "apiSpec": "A String", # The API spec that the external API implements. + "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. + "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. + "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + "apiKeyString": "A String", # Optional. The API key to be used in the request directly. + "httpElementLocation": "A String", # Optional. The location of the API key. + "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + }, + "authType": "A String", # Type of auth scheme. + "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. + "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + }, + "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. + "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + }, + "oauthConfig": { # Config for user oauth. # Config for user oauth. + "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + }, + "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. + "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + }, + }, + "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. + "index": "A String", # The ElasticSearch index to use. + "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. + "searchTemplate": "A String", # The ElasticSearch search template to use. + }, + "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search + "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. + }, + }, + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. + { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec + "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + ], + "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + "filter": "A String", # Optional. Filter strings to be passed to the search API. + "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. + }, + "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. + "ragCorpora": [ # Optional. Deprecated. Please use rag_resources instead. + "A String", + ], + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "hybridSearch": { # Config for Hybrid Search. # Optional. Config for Hybrid Search. + "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. The range is [0, 1], while 0 means sparse vector search only and 1 means dense vector search only. The default value is 0.5 which balances sparse and dense vector search equally. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. + "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + }, + "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` + }, + }, + "topK": 42, # Optional. The number of contexts to retrieve. + }, + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "storeContext": True or False, # Optional. Currently only supported for Gemini Multimodal Live API. In Gemini Multimodal Live API, if `store_context` bool is specified, Gemini will leverage it to automatically memorize the interactions between the client and Gemini, and retrieve context when needed to augment the response generation for users' ongoing and future interactions. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, + }, + ], + }, + }, + "turns": [ # Optional. A chronological list of conversation turns. Each turn represents a logical execution cycle (e.g., User Input -> Agent Response). + { # Represents a single turn/invocation in the conversation. + "events": [ # Optional. The list of events that occurred during this turn. + { # Represents a single event in the execution trace. + "activeTools": [ # Optional. The list of tools that were active/available to the agent at the time of this event. This overrides the `AgentConfig.tools` if set. + { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. + }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, + "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. + "A String", + ], + }, + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. + "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1beta1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. + "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1beta1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. + }, + ], + "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. If true, include the widget context token in the response. + }, + "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. + "A String", + ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, + }, + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. + "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. + "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. + "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. + }, + }, + "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation + "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more details. + "customConfigs": { # Optional. Custom configs for ParallelAiSearch. This field can be used to pass any parameter from the Parallel.ai Search API. See the Parallel.ai documentation for the full list of available parameters and their usage: https://docs.parallel.ai/api-reference/search-beta/search Currently only `source_policy`, `excerpts`, `max_results`, `mode`, `fetch_policy` can be set via this field. For example: { "source_policy": { "include_domains": ["google.com", "wikipedia.org"], "exclude_domains": ["example.com"] }, "fetch_policy": { "max_age_seconds": 3600 } } + "a_key": "", # Properties of the object. + }, + }, + "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. + "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported. + "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. + "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. + }, + }, + "apiSpec": "A String", # The API spec that the external API implements. + "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. + "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. + "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + "apiKeyString": "A String", # Optional. The API key to be used in the request directly. + "httpElementLocation": "A String", # Optional. The location of the API key. + "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + }, + "authType": "A String", # Type of auth scheme. + "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. + "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + }, + "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. + "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + }, + "oauthConfig": { # Config for user oauth. # Config for user oauth. + "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + }, + "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. + "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + }, + }, + "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. + "index": "A String", # The ElasticSearch index to use. + "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. + "searchTemplate": "A String", # The ElasticSearch search template to use. + }, + "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search + "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. + }, + }, + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. + { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec + "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + ], + "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + "filter": "A String", # Optional. Filter strings to be passed to the search API. + "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. + }, + "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. + "ragCorpora": [ # Optional. Deprecated. Please use rag_resources instead. + "A String", + ], + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "hybridSearch": { # Config for Hybrid Search. # Optional. Config for Hybrid Search. + "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. The range is [0, 1], while 0 means sparse vector search only and 1 means dense vector search only. The default value is 0.5 which balances sparse and dense vector search equally. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. + "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + }, + "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` + }, + }, + "topK": 42, # Optional. The number of contexts to retrieve. + }, + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "storeContext": True or False, # Optional. Currently only supported for Gemini Multimodal Live API. In Gemini Multimodal Live API, if `store_context` bool is specified, Gemini will leverage it to automatically memorize the interactions between the client and Gemini, and retrieve context when needed to augment the response generation for users' ongoing and future interactions. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, + }, + ], + "author": "A String", # Required. The ID of the agent or entity that generated this event. Use "user" to denote events generated by the end-user. + "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. + "code": "A String", # Required. The code to be executed. + "language": "A String", # Required. Programming language of the `code`. + }, + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "functionCall": { # A predicted FunctionCall returned from the model that contains a string representing the FunctionDeclaration.name and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. + "a_key": "", # Properties of the object. + }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. + "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. + "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. + { # Partial argument value of the function call. + "boolValue": True or False, # Optional. Represents a boolean value. + "jsonPath": "A String", # Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data". + "nullValue": "A String", # Optional. Represents a null value. + "numberValue": 3.14, # Optional. Represents a double value. + "stringValue": "A String", # Optional. Represents a string value. + "willContinue": True or False, # Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow. + }, + ], + "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. + }, + "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. + "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. + "a_key": "", # Properties of the object. + }, + "scheduling": "A String", # Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE. + }, + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. + "level": "A String", # The tokenization quality used for given media. + }, + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "endOffset": "A String", # Optional. The end offset of the video. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + "eventTime": "A String", # Optional. The timestamp when the event occurred. + "stateDelta": { # Optional. The change in the session state caused by this event. This is a key-value map of fields that were modified or added by the event. + "a_key": "", # Properties of the object. + }, + }, + ], + "turnId": "A String", # Optional. A unique identifier for the turn. Useful for referencing specific turns across systems. + "turnIndex": 42, # Required. The 0-based index of the turn in the conversation sequence. + }, + ], + }, + "candidate": "A String", # Required. The name of the candidate that produced the response. + "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). # Output only. Error while scraping model or agent. + "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. + }, + "events": [ # Optional. Intermediate events (such as tool calls and responses) that led to the final response. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. + "code": "A String", # Required. The code to be executed. + "language": "A String", # Required. Programming language of the `code`. + }, + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "functionCall": { # A predicted FunctionCall returned from the model that contains a string representing the FunctionDeclaration.name and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. + "a_key": "", # Properties of the object. + }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. + "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. + "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. + { # Partial argument value of the function call. + "boolValue": True or False, # Optional. Represents a boolean value. + "jsonPath": "A String", # Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data". + "nullValue": "A String", # Optional. Represents a null value. + "numberValue": 3.14, # Optional. Represents a double value. + "stringValue": "A String", # Optional. Represents a string value. + "willContinue": True or False, # Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow. + }, + ], + "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. + }, + "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. + "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. + "a_key": "", # Properties of the object. + }, + "scheduling": "A String", # Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE. + }, + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. + "level": "A String", # The tokenization quality used for given media. + }, + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "endOffset": "A String", # Optional. The end offset of the video. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + ], + "text": "A String", # Text response. + "value": "", # Fields and values that can be used to populate the response template. + }, + ], + "goldenResponse": { # Responses from model or agent. # Optional. The Ideal response or ground truth. + "agentData": { # Represents data specific to multi-turn agent evaluations. # Optional. Represents the complete execution trace of a multi-turn conversation, which can involve single or multiple agents. This field is used to provide the full output of an agent's run, including all turns and events, for direct evaluation. + "agents": { # Optional. A map containing the static configurations for each agent in the system. Key: agent_id (matches the `author` field in events). Value: The static configuration of the agent. + "a_key": { # Represents configuration for an Agent. + "agentId": "A String", # Required. Unique identifier of the agent. This ID is used to refer to this agent, e.g., in AgentEvent.author, or in the `sub_agents` field. It must be unique within the `agents` map. + "agentType": "A String", # Optional. The type or class of the agent (e.g., "LlmAgent", "RouterAgent", "ToolUseAgent"). Useful for the autorater to understand the expected behavior of the agent. + "description": "A String", # Optional. A high-level description of the agent's role and responsibilities. Critical for evaluating if the agent is routing tasks correctly. + "instruction": "A String", # Optional. Provides instructions for the LLM model, guiding the agent's behavior. Can be static or dynamic. Dynamic instructions can contain placeholders like {variable_name} that will be resolved at runtime using the `AgentEvent.state_delta` field. + "subAgents": [ # Optional. The list of valid agent IDs that this agent can delegate to. This defines the directed edges in the multi-agent system graph topology. + "A String", + ], + "tools": [ # Optional. The list of tools available to this agent. + { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. + }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, + "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. + "A String", + ], + }, + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. + "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1beta1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. + "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1beta1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. + }, + ], + "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. If true, include the widget context token in the response. + }, + "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. + "A String", + ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, + }, + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. + "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. + "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. + "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. + }, + }, + "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation + "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more details. + "customConfigs": { # Optional. Custom configs for ParallelAiSearch. This field can be used to pass any parameter from the Parallel.ai Search API. See the Parallel.ai documentation for the full list of available parameters and their usage: https://docs.parallel.ai/api-reference/search-beta/search Currently only `source_policy`, `excerpts`, `max_results`, `mode`, `fetch_policy` can be set via this field. For example: { "source_policy": { "include_domains": ["google.com", "wikipedia.org"], "exclude_domains": ["example.com"] }, "fetch_policy": { "max_age_seconds": 3600 } } + "a_key": "", # Properties of the object. + }, + }, + "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. + "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported. + "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. + "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. + }, + }, + "apiSpec": "A String", # The API spec that the external API implements. + "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. + "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. + "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + "apiKeyString": "A String", # Optional. The API key to be used in the request directly. + "httpElementLocation": "A String", # Optional. The location of the API key. + "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + }, + "authType": "A String", # Type of auth scheme. + "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. + "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + }, + "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. + "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + }, + "oauthConfig": { # Config for user oauth. # Config for user oauth. + "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + }, + "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. + "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + }, + }, + "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. + "index": "A String", # The ElasticSearch index to use. + "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. + "searchTemplate": "A String", # The ElasticSearch search template to use. + }, + "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search + "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. + }, + }, + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. + { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec + "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + ], + "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + "filter": "A String", # Optional. Filter strings to be passed to the search API. + "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. + }, + "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. + "ragCorpora": [ # Optional. Deprecated. Please use rag_resources instead. + "A String", + ], + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "hybridSearch": { # Config for Hybrid Search. # Optional. Config for Hybrid Search. + "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. The range is [0, 1], while 0 means sparse vector search only and 1 means dense vector search only. The default value is 0.5 which balances sparse and dense vector search equally. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. + "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + }, + "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` + }, + }, + "topK": 42, # Optional. The number of contexts to retrieve. + }, + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "storeContext": True or False, # Optional. Currently only supported for Gemini Multimodal Live API. In Gemini Multimodal Live API, if `store_context` bool is specified, Gemini will leverage it to automatically memorize the interactions between the client and Gemini, and retrieve context when needed to augment the response generation for users' ongoing and future interactions. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, + }, + ], + }, + }, + "turns": [ # Optional. A chronological list of conversation turns. Each turn represents a logical execution cycle (e.g., User Input -> Agent Response). + { # Represents a single turn/invocation in the conversation. + "events": [ # Optional. The list of events that occurred during this turn. + { # Represents a single event in the execution trace. + "activeTools": [ # Optional. The list of tools that were active/available to the agent at the time of this event. This overrides the `AgentConfig.tools` if set. + { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. + }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, + "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. + "A String", + ], + }, + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. + "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1beta1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. + "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1beta1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. + }, + ], + "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. If true, include the widget context token in the response. + }, + "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. + "A String", + ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, + }, + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. + "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. + "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. + "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. + }, + }, + "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation + "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more details. + "customConfigs": { # Optional. Custom configs for ParallelAiSearch. This field can be used to pass any parameter from the Parallel.ai Search API. See the Parallel.ai documentation for the full list of available parameters and their usage: https://docs.parallel.ai/api-reference/search-beta/search Currently only `source_policy`, `excerpts`, `max_results`, `mode`, `fetch_policy` can be set via this field. For example: { "source_policy": { "include_domains": ["google.com", "wikipedia.org"], "exclude_domains": ["example.com"] }, "fetch_policy": { "max_age_seconds": 3600 } } + "a_key": "", # Properties of the object. + }, + }, + "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. + "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported. + "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. + "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. + }, + }, + "apiSpec": "A String", # The API spec that the external API implements. + "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. + "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. + "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + "apiKeyString": "A String", # Optional. The API key to be used in the request directly. + "httpElementLocation": "A String", # Optional. The location of the API key. + "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + }, + "authType": "A String", # Type of auth scheme. + "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. + "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + }, + "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. + "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + }, + "oauthConfig": { # Config for user oauth. # Config for user oauth. + "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + }, + "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. + "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + }, + }, + "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. + "index": "A String", # The ElasticSearch index to use. + "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. + "searchTemplate": "A String", # The ElasticSearch search template to use. + }, + "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search + "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. + }, + }, + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. + { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec + "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + ], + "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + "filter": "A String", # Optional. Filter strings to be passed to the search API. + "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. + }, + "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. + "ragCorpora": [ # Optional. Deprecated. Please use rag_resources instead. + "A String", + ], + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "hybridSearch": { # Config for Hybrid Search. # Optional. Config for Hybrid Search. + "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. The range is [0, 1], while 0 means sparse vector search only and 1 means dense vector search only. The default value is 0.5 which balances sparse and dense vector search equally. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. + "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + }, + "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` + }, + }, + "topK": 42, # Optional. The number of contexts to retrieve. + }, + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "storeContext": True or False, # Optional. Currently only supported for Gemini Multimodal Live API. In Gemini Multimodal Live API, if `store_context` bool is specified, Gemini will leverage it to automatically memorize the interactions between the client and Gemini, and retrieve context when needed to augment the response generation for users' ongoing and future interactions. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, + }, + ], + "author": "A String", # Required. The ID of the agent or entity that generated this event. Use "user" to denote events generated by the end-user. + "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. + "code": "A String", # Required. The code to be executed. + "language": "A String", # Required. Programming language of the `code`. + }, + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "functionCall": { # A predicted FunctionCall returned from the model that contains a string representing the FunctionDeclaration.name and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. + "a_key": "", # Properties of the object. + }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. + "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. + "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. + { # Partial argument value of the function call. + "boolValue": True or False, # Optional. Represents a boolean value. + "jsonPath": "A String", # Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data". + "nullValue": "A String", # Optional. Represents a null value. + "numberValue": 3.14, # Optional. Represents a double value. + "stringValue": "A String", # Optional. Represents a string value. + "willContinue": True or False, # Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow. + }, + ], + "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. + }, + "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. + "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. + "a_key": "", # Properties of the object. + }, + "scheduling": "A String", # Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE. + }, + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. + "level": "A String", # The tokenization quality used for given media. + }, + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "endOffset": "A String", # Optional. The end offset of the video. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + "eventTime": "A String", # Optional. The timestamp when the event occurred. + "stateDelta": { # Optional. The change in the session state caused by this event. This is a key-value map of fields that were modified or added by the event. + "a_key": "", # Properties of the object. + }, + }, + ], + "turnId": "A String", # Optional. A unique identifier for the turn. Useful for referencing specific turns across systems. + "turnIndex": 42, # Required. The 0-based index of the turn in the conversation sequence. + }, + ], + }, + "candidate": "A String", # Required. The name of the candidate that produced the response. + "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). # Output only. Error while scraping model or agent. + "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. + }, + "events": [ # Optional. Intermediate events (such as tool calls and responses) that led to the final response. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. + "code": "A String", # Required. The code to be executed. + "language": "A String", # Required. Programming language of the `code`. + }, + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "functionCall": { # A predicted FunctionCall returned from the model that contains a string representing the FunctionDeclaration.name and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. + "a_key": "", # Properties of the object. + }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. + "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. + "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. + { # Partial argument value of the function call. + "boolValue": True or False, # Optional. Represents a boolean value. + "jsonPath": "A String", # Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data". + "nullValue": "A String", # Optional. Represents a null value. + "numberValue": 3.14, # Optional. Represents a double value. + "stringValue": "A String", # Optional. Represents a string value. + "willContinue": True or False, # Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow. + }, + ], + "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. + }, + "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. + "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. + "a_key": "", # Properties of the object. + }, + "scheduling": "A String", # Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE. + }, + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. + "level": "A String", # The tokenization quality used for given media. + }, + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "endOffset": "A String", # Optional. The end offset of the video. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + ], + "text": "A String", # Text response. + "value": "", # Fields and values that can be used to populate the response template. + }, + "prompt": { # Prompt to be evaluated. This can represent a single-turn prompt or a multi-turn conversation for agent evaluations. # Optional. The request/prompt to evaluate. + "agentData": { # Represents data specific to multi-turn agent evaluations. # Optional. Represents the complete execution trace of a multi-turn conversation, which can involve single or multiple agents. This serves as the input context for agent scraping. + "agents": { # Optional. A map containing the static configurations for each agent in the system. Key: agent_id (matches the `author` field in events). Value: The static configuration of the agent. + "a_key": { # Represents configuration for an Agent. + "agentId": "A String", # Required. Unique identifier of the agent. This ID is used to refer to this agent, e.g., in AgentEvent.author, or in the `sub_agents` field. It must be unique within the `agents` map. + "agentType": "A String", # Optional. The type or class of the agent (e.g., "LlmAgent", "RouterAgent", "ToolUseAgent"). Useful for the autorater to understand the expected behavior of the agent. + "description": "A String", # Optional. A high-level description of the agent's role and responsibilities. Critical for evaluating if the agent is routing tasks correctly. + "instruction": "A String", # Optional. Provides instructions for the LLM model, guiding the agent's behavior. Can be static or dynamic. Dynamic instructions can contain placeholders like {variable_name} that will be resolved at runtime using the `AgentEvent.state_delta` field. + "subAgents": [ # Optional. The list of valid agent IDs that this agent can delegate to. This defines the directed edges in the multi-agent system graph topology. + "A String", + ], + "tools": [ # Optional. The list of tools available to this agent. + { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. + }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, + "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. + "A String", + ], + }, + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. + "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1beta1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. + "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1beta1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. + }, + ], + "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. If true, include the widget context token in the response. + }, + "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. + "A String", + ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, + }, + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. + "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. + "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. + "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. + }, + }, + "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation + "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more details. + "customConfigs": { # Optional. Custom configs for ParallelAiSearch. This field can be used to pass any parameter from the Parallel.ai Search API. See the Parallel.ai documentation for the full list of available parameters and their usage: https://docs.parallel.ai/api-reference/search-beta/search Currently only `source_policy`, `excerpts`, `max_results`, `mode`, `fetch_policy` can be set via this field. For example: { "source_policy": { "include_domains": ["google.com", "wikipedia.org"], "exclude_domains": ["example.com"] }, "fetch_policy": { "max_age_seconds": 3600 } } + "a_key": "", # Properties of the object. + }, + }, + "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. + "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported. + "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. + "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. + }, + }, + "apiSpec": "A String", # The API spec that the external API implements. + "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. + "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. + "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + "apiKeyString": "A String", # Optional. The API key to be used in the request directly. + "httpElementLocation": "A String", # Optional. The location of the API key. + "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + }, + "authType": "A String", # Type of auth scheme. + "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. + "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + }, + "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. + "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + }, + "oauthConfig": { # Config for user oauth. # Config for user oauth. + "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + }, + "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. + "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + }, + }, + "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. + "index": "A String", # The ElasticSearch index to use. + "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. + "searchTemplate": "A String", # The ElasticSearch search template to use. + }, + "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search + "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. + }, + }, + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. + { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec + "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + ], + "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + "filter": "A String", # Optional. Filter strings to be passed to the search API. + "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. + }, + "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. + "ragCorpora": [ # Optional. Deprecated. Please use rag_resources instead. + "A String", + ], + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "hybridSearch": { # Config for Hybrid Search. # Optional. Config for Hybrid Search. + "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. The range is [0, 1], while 0 means sparse vector search only and 1 means dense vector search only. The default value is 0.5 which balances sparse and dense vector search equally. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. + "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + }, + "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` + }, + }, + "topK": 42, # Optional. The number of contexts to retrieve. + }, + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "storeContext": True or False, # Optional. Currently only supported for Gemini Multimodal Live API. In Gemini Multimodal Live API, if `store_context` bool is specified, Gemini will leverage it to automatically memorize the interactions between the client and Gemini, and retrieve context when needed to augment the response generation for users' ongoing and future interactions. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, + }, + ], + }, + }, + "turns": [ # Optional. A chronological list of conversation turns. Each turn represents a logical execution cycle (e.g., User Input -> Agent Response). + { # Represents a single turn/invocation in the conversation. + "events": [ # Optional. The list of events that occurred during this turn. + { # Represents a single event in the execution trace. + "activeTools": [ # Optional. The list of tools that were active/available to the agent at the time of this event. This overrides the `AgentConfig.tools` if set. + { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. + }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, + "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. + "A String", + ], + }, + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. + "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1beta1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. + "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1beta1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. + }, + ], + "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. If true, include the widget context token in the response. + }, + "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. + "A String", + ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, + }, + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. + "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. + "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. + "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. + }, + }, + "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation + "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more details. + "customConfigs": { # Optional. Custom configs for ParallelAiSearch. This field can be used to pass any parameter from the Parallel.ai Search API. See the Parallel.ai documentation for the full list of available parameters and their usage: https://docs.parallel.ai/api-reference/search-beta/search Currently only `source_policy`, `excerpts`, `max_results`, `mode`, `fetch_policy` can be set via this field. For example: { "source_policy": { "include_domains": ["google.com", "wikipedia.org"], "exclude_domains": ["example.com"] }, "fetch_policy": { "max_age_seconds": 3600 } } + "a_key": "", # Properties of the object. + }, + }, + "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. + "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported. + "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. + "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. + }, + }, + "apiSpec": "A String", # The API spec that the external API implements. + "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. + "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. + "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + "apiKeyString": "A String", # Optional. The API key to be used in the request directly. + "httpElementLocation": "A String", # Optional. The location of the API key. + "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + }, + "authType": "A String", # Type of auth scheme. + "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. + "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + }, + "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. + "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + }, + "oauthConfig": { # Config for user oauth. # Config for user oauth. + "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + }, + "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. + "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + }, + }, + "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. + "index": "A String", # The ElasticSearch index to use. + "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. + "searchTemplate": "A String", # The ElasticSearch search template to use. + }, + "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search + "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. + }, + }, + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. + { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec + "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + ], + "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + "filter": "A String", # Optional. Filter strings to be passed to the search API. + "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. + }, + "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. + "ragCorpora": [ # Optional. Deprecated. Please use rag_resources instead. + "A String", + ], + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "hybridSearch": { # Config for Hybrid Search. # Optional. Config for Hybrid Search. + "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. The range is [0, 1], while 0 means sparse vector search only and 1 means dense vector search only. The default value is 0.5 which balances sparse and dense vector search equally. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. + "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + }, + "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` + }, + }, + "topK": 42, # Optional. The number of contexts to retrieve. + }, + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "storeContext": True or False, # Optional. Currently only supported for Gemini Multimodal Live API. In Gemini Multimodal Live API, if `store_context` bool is specified, Gemini will leverage it to automatically memorize the interactions between the client and Gemini, and retrieve context when needed to augment the response generation for users' ongoing and future interactions. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, + }, + ], + "author": "A String", # Required. The ID of the agent or entity that generated this event. Use "user" to denote events generated by the end-user. + "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. + "code": "A String", # Required. The code to be executed. + "language": "A String", # Required. Programming language of the `code`. + }, + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "functionCall": { # A predicted FunctionCall returned from the model that contains a string representing the FunctionDeclaration.name and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. + "a_key": "", # Properties of the object. + }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. + "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. + "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. + { # Partial argument value of the function call. + "boolValue": True or False, # Optional. Represents a boolean value. + "jsonPath": "A String", # Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data". + "nullValue": "A String", # Optional. Represents a null value. + "numberValue": 3.14, # Optional. Represents a double value. + "stringValue": "A String", # Optional. Represents a string value. + "willContinue": True or False, # Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow. + }, + ], + "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. + }, + "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. + "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. + "a_key": "", # Properties of the object. + }, + "scheduling": "A String", # Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE. + }, + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. + "level": "A String", # The tokenization quality used for given media. + }, + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "endOffset": "A String", # Optional. The end offset of the video. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + "eventTime": "A String", # Optional. The timestamp when the event occurred. + "stateDelta": { # Optional. The change in the session state caused by this event. This is a key-value map of fields that were modified or added by the event. + "a_key": "", # Properties of the object. + }, + }, + ], + "turnId": "A String", # Optional. A unique identifier for the turn. Useful for referencing specific turns across systems. + "turnIndex": 42, # Required. The 0-based index of the turn in the conversation sequence. + }, + ], + }, + "promptTemplateData": { # Message to hold a prompt template and the values to populate the template. # Prompt template data. + "values": { # The values for fields in the prompt template. + "a_key": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. + "code": "A String", # Required. The code to be executed. + "language": "A String", # Required. Programming language of the `code`. + }, + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "functionCall": { # A predicted FunctionCall returned from the model that contains a string representing the FunctionDeclaration.name and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. + "a_key": "", # Properties of the object. + }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. + "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. + "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. + { # Partial argument value of the function call. + "boolValue": True or False, # Optional. Represents a boolean value. + "jsonPath": "A String", # Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data". + "nullValue": "A String", # Optional. Represents a null value. + "numberValue": 3.14, # Optional. Represents a double value. + "stringValue": "A String", # Optional. Represents a string value. + "willContinue": True or False, # Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow. + }, + ], + "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. + }, + "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. + "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. + "a_key": "", # Properties of the object. + }, + "scheduling": "A String", # Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE. + }, + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. + "level": "A String", # The tokenization quality used for given media. + }, + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "endOffset": "A String", # Optional. The end offset of the video. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + }, + }, + "text": "A String", # Text prompt. + "userScenario": { # User scenario to help simulate multi-turn agent running results. # Optional. The generated user scenario used to drive multi-turn agent running results. + "conversationPlan": "A String", # Required. The plan for the conversation, used to drive the multi-turn agent run and generate the simulated agent evaluation dataset. + "startingPrompt": "A String", # Required. The prompt that starts the conversation between the simulated user and the agent under test. + }, + "value": "", # Fields and values that can be used to populate the prompt template. + }, + "rubrics": { # Optional. Named groups of rubrics associated with this prompt. The key is a user-defined name for the rubric group. + "a_key": { # A group of rubrics, used for grouping rubrics based on a metric or a version. + "displayName": "A String", # Human-readable name for the group. This should be unique within a given context if used for display or selection. Example: "Instruction Following V1", "Content Quality - Summarization Task". + "groupId": "A String", # Unique identifier for the group. + "rubrics": [ # Rubrics that are part of this group. + { # Message representing a single testable criterion for evaluation. One input prompt could have multiple rubrics. + "content": { # Content of the rubric, defining the testable criteria. # Required. The actual testable criteria for the rubric. + "property": { # Defines criteria based on a specific property. # Evaluation criteria based on a specific property. + "description": "A String", # Description of the property being evaluated. Example: "The model's response is grammatically correct." + }, + }, + "importance": "A String", # Optional. The relative importance of this rubric. + "rubricId": "A String", # Unique identifier for the rubric. This ID is used to refer to this rubric, e.g., in RubricVerdict. + "type": "A String", # Optional. A type designator for the rubric, which can inform how it's evaluated or interpreted by systems or users. It's recommended to use consistent, well-defined, upper snake_case strings. Examples: "SUMMARIZATION_QUALITY", "SAFETY_HARMFUL_CONTENT", "INSTRUCTION_ADHERENCE". + }, + ], + }, + }, + }, + }, + "failedRubrics": [ # The specific rubric(s) that failed and caused this example to be classified here. An example might fail multiple rubrics, but only specific ones trigger this loss pattern. + { # Represents a specific failed rubric and the associated analysis. + "classificationRationale": "A String", # The rationale provided by the Loss Analysis Classifier for why this failure maps to this specific Loss Cluster. e.g., "The agent claimed an action without a tool call, matching 'Hallucination of Action'." + "rubricId": "A String", # The unique ID of the rubric (if available from the metric source). Clients use this ID to query the corresponding rubric verdict. + }, + ], + }, + ], + "itemCount": 42, # The total number of EvaluationItems falling into this cluster. + "taxonomyEntry": { # Defines a specific entry in the loss pattern taxonomy. # The structured definition of the loss taxonomy for this cluster. + "description": "A String", # A detailed description of this loss pattern. Example: "The agent verbally confirms an action without executing the tool." + "l1Category": "A String", # The primary category of the loss (e.g., "Hallucination", "Tool Calling"). This field is typically required. + "l2Category": "A String", # The secondary category of the loss (e.g., "Hallucination of Action", "Incorrect Tool Selection"). + }, + }, + ], + "config": { # Configuration for the loss analysis job. # The configuration used to generate this analysis. + "candidate": "A String", # Required. The candidate model/agent to analyze (e.g., "gemini-3.0-pro"). This targets the specific CandidateResult within the EvaluationResult. + "metric": "A String", # Required. The metric to analyze (e.g., "tool_use_quality"). This filters the EvaluationItems in the EvalSet to only those where EvaluationResult.metric matches this value. + }, + }, + ], "summaryMetrics": { # The summary metrics for the evaluation run. # Optional. The summary metrics for the evaluation run. "failedItems": 42, # Optional. The number of items that failed to be evaluated. "metrics": { # Optional. Map of metric name to metric value. @@ -6320,6 +12356,12 @@

Method Details

"displayName": "A String", # Optional. A display name for this custom summary metric. Used to prefix keys in the output summaryMetrics map. If not provided, a default name like "dataset_custom_metric_1", "dataset_custom_metric_2", etc., will be generated based on the order in the repeated field. }, ], + "lossAnalysisConfig": [ # Optional. Specifications for loss analysis. Each config can be specified for one metric. + { # Configuration for the loss analysis job. + "candidate": "A String", # Required. The candidate model/agent to analyze (e.g., "gemini-3.0-pro"). This targets the specific CandidateResult within the EvaluationResult. + "metric": "A String", # Required. The metric to analyze (e.g., "tool_use_quality"). This filters the EvaluationItems in the EvalSet to only those where EvaluationResult.metric matches this value. + }, + ], "metrics": [ # Required. The metrics to be calculated in the evaluation run. { # The metric used for evaluation runs. "computationBasedMetricSpec": { # Specification for a computation based metric. # Spec for a computation based metric. @@ -7341,6 +13383,2012 @@

Method Details

}, "evaluationResults": { # The results of the evaluation run. # Output only. The results of the evaluation run. Only populated when the evaluation run's state is SUCCEEDED. "evaluationSet": "A String", # The evaluation set where item level results are stored. + "lossAnalysisResults": [ # Output only. The results of the auto-loss analysis performed on the eval set associated with the run. + { # The top-level result for loss analysis, stored within an EvalSet. + "analysisTime": "A String", # The timestamp when this analysis was performed. + "clusters": [ # The list of identified loss clusters. + { # Represents a semantic grouping of failures (e.g., "Hallucination of Action"). + "clusterId": "A String", # Unique identifier for the loss cluster within the scope of the analysis result. + "examples": [ # A list of examples that belong to this cluster. This links the cluster back to the specific EvaluationItems and Rubrics. + { # Represents a specific example of a loss pattern. + "evaluationItem": "A String", # Reference to the persisted EvalItem resource name. Format: projects/.../locations/.../evaluationItems/{item_id} Used when analysis is run on an EvalSet. + "evaluationResult": { # Evaluation result. # The full evaluation result object provided inline. Used when the analysis is performed on ephemeral data (without an EvaluationSet). + "candidateResults": [ # Optional. The results for the metric. + { # Result for a single candidate. + "additionalResults": "", # Optional. Additional results for the metric. + "candidate": "A String", # Required. The candidate that is being evaluated. The value is the same as the candidate name in the EvaluationRequest. + "explanation": "A String", # Optional. The explanation for the metric. + "metric": "A String", # Required. The metric that was evaluated. + "rubricVerdicts": [ # Optional. The rubric verdicts for the metric. + { # Represents the verdict of an evaluation against a single rubric. + "evaluatedRubric": { # Message representing a single testable criterion for evaluation. One input prompt could have multiple rubrics. # Required. The full rubric definition that was evaluated. Storing this ensures the verdict is self-contained and understandable, especially if the original rubric definition changes or was dynamically generated. + "content": { # Content of the rubric, defining the testable criteria. # Required. The actual testable criteria for the rubric. + "property": { # Defines criteria based on a specific property. # Evaluation criteria based on a specific property. + "description": "A String", # Description of the property being evaluated. Example: "The model's response is grammatically correct." + }, + }, + "importance": "A String", # Optional. The relative importance of this rubric. + "rubricId": "A String", # Unique identifier for the rubric. This ID is used to refer to this rubric, e.g., in RubricVerdict. + "type": "A String", # Optional. A type designator for the rubric, which can inform how it's evaluated or interpreted by systems or users. It's recommended to use consistent, well-defined, upper snake_case strings. Examples: "SUMMARIZATION_QUALITY", "SAFETY_HARMFUL_CONTENT", "INSTRUCTION_ADHERENCE". + }, + "reasoning": "A String", # Optional. Human-readable reasoning or explanation for the verdict. This can include specific examples or details from the evaluated content that justify the given verdict. + "verdict": True or False, # Required. Outcome of the evaluation against the rubric, represented as a boolean. `true` indicates a "Pass", `false` indicates a "Fail". + }, + ], + "score": 3.14, # Optional. The score for the metric. + }, + ], + "evaluationRequest": "A String", # Required. The request item that was evaluated. Format: projects/{project}/locations/{location}/evaluationItems/{evaluation_item} + "evaluationRun": "A String", # Required. The evaluation run that was used to generate the result. Format: projects/{project}/locations/{location}/evaluationRuns/{evaluation_run} + "metadata": "", # Optional. Metadata about the evaluation result. + "metric": "A String", # Required. The metric that was evaluated. + "request": { # A single evaluation request supporting input for both single-turn model generation and multi-turn agent execution traces. Valid input modes: 1. Inference Mode: `prompt` is set (containing text or AgentData context). 2. Offline Eval Mode: `prompt` is unset, and `candidate_responses` contains `agent_data` (the completed execution trace). Validation Rule: Either `prompt` must be set, OR at least one of the `candidate_responses` must contain `agent_data`. # Required. The request that was evaluated. + "candidateResponses": [ # Optional. Responses from model under test and other baseline models for comparison. + { # Responses from model or agent. + "agentData": { # Represents data specific to multi-turn agent evaluations. # Optional. Represents the complete execution trace of a multi-turn conversation, which can involve single or multiple agents. This field is used to provide the full output of an agent's run, including all turns and events, for direct evaluation. + "agents": { # Optional. A map containing the static configurations for each agent in the system. Key: agent_id (matches the `author` field in events). Value: The static configuration of the agent. + "a_key": { # Represents configuration for an Agent. + "agentId": "A String", # Required. Unique identifier of the agent. This ID is used to refer to this agent, e.g., in AgentEvent.author, or in the `sub_agents` field. It must be unique within the `agents` map. + "agentType": "A String", # Optional. The type or class of the agent (e.g., "LlmAgent", "RouterAgent", "ToolUseAgent"). Useful for the autorater to understand the expected behavior of the agent. + "description": "A String", # Optional. A high-level description of the agent's role and responsibilities. Critical for evaluating if the agent is routing tasks correctly. + "instruction": "A String", # Optional. Provides instructions for the LLM model, guiding the agent's behavior. Can be static or dynamic. Dynamic instructions can contain placeholders like {variable_name} that will be resolved at runtime using the `AgentEvent.state_delta` field. + "subAgents": [ # Optional. The list of valid agent IDs that this agent can delegate to. This defines the directed edges in the multi-agent system graph topology. + "A String", + ], + "tools": [ # Optional. The list of tools available to this agent. + { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. + }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, + "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. + "A String", + ], + }, + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. + "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1beta1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. + "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1beta1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. + }, + ], + "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. If true, include the widget context token in the response. + }, + "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. + "A String", + ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, + }, + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. + "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. + "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. + "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. + }, + }, + "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation + "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more details. + "customConfigs": { # Optional. Custom configs for ParallelAiSearch. This field can be used to pass any parameter from the Parallel.ai Search API. See the Parallel.ai documentation for the full list of available parameters and their usage: https://docs.parallel.ai/api-reference/search-beta/search Currently only `source_policy`, `excerpts`, `max_results`, `mode`, `fetch_policy` can be set via this field. For example: { "source_policy": { "include_domains": ["google.com", "wikipedia.org"], "exclude_domains": ["example.com"] }, "fetch_policy": { "max_age_seconds": 3600 } } + "a_key": "", # Properties of the object. + }, + }, + "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. + "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported. + "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. + "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. + }, + }, + "apiSpec": "A String", # The API spec that the external API implements. + "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. + "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. + "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + "apiKeyString": "A String", # Optional. The API key to be used in the request directly. + "httpElementLocation": "A String", # Optional. The location of the API key. + "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + }, + "authType": "A String", # Type of auth scheme. + "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. + "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + }, + "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. + "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + }, + "oauthConfig": { # Config for user oauth. # Config for user oauth. + "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + }, + "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. + "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + }, + }, + "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. + "index": "A String", # The ElasticSearch index to use. + "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. + "searchTemplate": "A String", # The ElasticSearch search template to use. + }, + "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search + "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. + }, + }, + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. + { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec + "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + ], + "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + "filter": "A String", # Optional. Filter strings to be passed to the search API. + "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. + }, + "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. + "ragCorpora": [ # Optional. Deprecated. Please use rag_resources instead. + "A String", + ], + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "hybridSearch": { # Config for Hybrid Search. # Optional. Config for Hybrid Search. + "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. The range is [0, 1], while 0 means sparse vector search only and 1 means dense vector search only. The default value is 0.5 which balances sparse and dense vector search equally. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. + "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + }, + "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` + }, + }, + "topK": 42, # Optional. The number of contexts to retrieve. + }, + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "storeContext": True or False, # Optional. Currently only supported for Gemini Multimodal Live API. In Gemini Multimodal Live API, if `store_context` bool is specified, Gemini will leverage it to automatically memorize the interactions between the client and Gemini, and retrieve context when needed to augment the response generation for users' ongoing and future interactions. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, + }, + ], + }, + }, + "turns": [ # Optional. A chronological list of conversation turns. Each turn represents a logical execution cycle (e.g., User Input -> Agent Response). + { # Represents a single turn/invocation in the conversation. + "events": [ # Optional. The list of events that occurred during this turn. + { # Represents a single event in the execution trace. + "activeTools": [ # Optional. The list of tools that were active/available to the agent at the time of this event. This overrides the `AgentConfig.tools` if set. + { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. + }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, + "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. + "A String", + ], + }, + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. + "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1beta1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. + "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1beta1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. + }, + ], + "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. If true, include the widget context token in the response. + }, + "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. + "A String", + ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, + }, + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. + "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. + "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. + "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. + }, + }, + "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation + "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more details. + "customConfigs": { # Optional. Custom configs for ParallelAiSearch. This field can be used to pass any parameter from the Parallel.ai Search API. See the Parallel.ai documentation for the full list of available parameters and their usage: https://docs.parallel.ai/api-reference/search-beta/search Currently only `source_policy`, `excerpts`, `max_results`, `mode`, `fetch_policy` can be set via this field. For example: { "source_policy": { "include_domains": ["google.com", "wikipedia.org"], "exclude_domains": ["example.com"] }, "fetch_policy": { "max_age_seconds": 3600 } } + "a_key": "", # Properties of the object. + }, + }, + "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. + "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported. + "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. + "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. + }, + }, + "apiSpec": "A String", # The API spec that the external API implements. + "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. + "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. + "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + "apiKeyString": "A String", # Optional. The API key to be used in the request directly. + "httpElementLocation": "A String", # Optional. The location of the API key. + "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + }, + "authType": "A String", # Type of auth scheme. + "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. + "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + }, + "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. + "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + }, + "oauthConfig": { # Config for user oauth. # Config for user oauth. + "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + }, + "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. + "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + }, + }, + "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. + "index": "A String", # The ElasticSearch index to use. + "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. + "searchTemplate": "A String", # The ElasticSearch search template to use. + }, + "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search + "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. + }, + }, + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. + { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec + "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + ], + "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + "filter": "A String", # Optional. Filter strings to be passed to the search API. + "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. + }, + "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. + "ragCorpora": [ # Optional. Deprecated. Please use rag_resources instead. + "A String", + ], + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "hybridSearch": { # Config for Hybrid Search. # Optional. Config for Hybrid Search. + "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. The range is [0, 1], while 0 means sparse vector search only and 1 means dense vector search only. The default value is 0.5 which balances sparse and dense vector search equally. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. + "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + }, + "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` + }, + }, + "topK": 42, # Optional. The number of contexts to retrieve. + }, + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "storeContext": True or False, # Optional. Currently only supported for Gemini Multimodal Live API. In Gemini Multimodal Live API, if `store_context` bool is specified, Gemini will leverage it to automatically memorize the interactions between the client and Gemini, and retrieve context when needed to augment the response generation for users' ongoing and future interactions. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, + }, + ], + "author": "A String", # Required. The ID of the agent or entity that generated this event. Use "user" to denote events generated by the end-user. + "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. + "code": "A String", # Required. The code to be executed. + "language": "A String", # Required. Programming language of the `code`. + }, + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "functionCall": { # A predicted FunctionCall returned from the model that contains a string representing the FunctionDeclaration.name and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. + "a_key": "", # Properties of the object. + }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. + "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. + "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. + { # Partial argument value of the function call. + "boolValue": True or False, # Optional. Represents a boolean value. + "jsonPath": "A String", # Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data". + "nullValue": "A String", # Optional. Represents a null value. + "numberValue": 3.14, # Optional. Represents a double value. + "stringValue": "A String", # Optional. Represents a string value. + "willContinue": True or False, # Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow. + }, + ], + "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. + }, + "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. + "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. + "a_key": "", # Properties of the object. + }, + "scheduling": "A String", # Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE. + }, + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. + "level": "A String", # The tokenization quality used for given media. + }, + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "endOffset": "A String", # Optional. The end offset of the video. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + "eventTime": "A String", # Optional. The timestamp when the event occurred. + "stateDelta": { # Optional. The change in the session state caused by this event. This is a key-value map of fields that were modified or added by the event. + "a_key": "", # Properties of the object. + }, + }, + ], + "turnId": "A String", # Optional. A unique identifier for the turn. Useful for referencing specific turns across systems. + "turnIndex": 42, # Required. The 0-based index of the turn in the conversation sequence. + }, + ], + }, + "candidate": "A String", # Required. The name of the candidate that produced the response. + "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). # Output only. Error while scraping model or agent. + "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. + }, + "events": [ # Optional. Intermediate events (such as tool calls and responses) that led to the final response. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. + "code": "A String", # Required. The code to be executed. + "language": "A String", # Required. Programming language of the `code`. + }, + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "functionCall": { # A predicted FunctionCall returned from the model that contains a string representing the FunctionDeclaration.name and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. + "a_key": "", # Properties of the object. + }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. + "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. + "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. + { # Partial argument value of the function call. + "boolValue": True or False, # Optional. Represents a boolean value. + "jsonPath": "A String", # Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data". + "nullValue": "A String", # Optional. Represents a null value. + "numberValue": 3.14, # Optional. Represents a double value. + "stringValue": "A String", # Optional. Represents a string value. + "willContinue": True or False, # Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow. + }, + ], + "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. + }, + "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. + "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. + "a_key": "", # Properties of the object. + }, + "scheduling": "A String", # Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE. + }, + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. + "level": "A String", # The tokenization quality used for given media. + }, + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "endOffset": "A String", # Optional. The end offset of the video. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + ], + "text": "A String", # Text response. + "value": "", # Fields and values that can be used to populate the response template. + }, + ], + "goldenResponse": { # Responses from model or agent. # Optional. The Ideal response or ground truth. + "agentData": { # Represents data specific to multi-turn agent evaluations. # Optional. Represents the complete execution trace of a multi-turn conversation, which can involve single or multiple agents. This field is used to provide the full output of an agent's run, including all turns and events, for direct evaluation. + "agents": { # Optional. A map containing the static configurations for each agent in the system. Key: agent_id (matches the `author` field in events). Value: The static configuration of the agent. + "a_key": { # Represents configuration for an Agent. + "agentId": "A String", # Required. Unique identifier of the agent. This ID is used to refer to this agent, e.g., in AgentEvent.author, or in the `sub_agents` field. It must be unique within the `agents` map. + "agentType": "A String", # Optional. The type or class of the agent (e.g., "LlmAgent", "RouterAgent", "ToolUseAgent"). Useful for the autorater to understand the expected behavior of the agent. + "description": "A String", # Optional. A high-level description of the agent's role and responsibilities. Critical for evaluating if the agent is routing tasks correctly. + "instruction": "A String", # Optional. Provides instructions for the LLM model, guiding the agent's behavior. Can be static or dynamic. Dynamic instructions can contain placeholders like {variable_name} that will be resolved at runtime using the `AgentEvent.state_delta` field. + "subAgents": [ # Optional. The list of valid agent IDs that this agent can delegate to. This defines the directed edges in the multi-agent system graph topology. + "A String", + ], + "tools": [ # Optional. The list of tools available to this agent. + { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. + }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, + "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. + "A String", + ], + }, + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. + "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1beta1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. + "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1beta1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. + }, + ], + "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. If true, include the widget context token in the response. + }, + "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. + "A String", + ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, + }, + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. + "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. + "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. + "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. + }, + }, + "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation + "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more details. + "customConfigs": { # Optional. Custom configs for ParallelAiSearch. This field can be used to pass any parameter from the Parallel.ai Search API. See the Parallel.ai documentation for the full list of available parameters and their usage: https://docs.parallel.ai/api-reference/search-beta/search Currently only `source_policy`, `excerpts`, `max_results`, `mode`, `fetch_policy` can be set via this field. For example: { "source_policy": { "include_domains": ["google.com", "wikipedia.org"], "exclude_domains": ["example.com"] }, "fetch_policy": { "max_age_seconds": 3600 } } + "a_key": "", # Properties of the object. + }, + }, + "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. + "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported. + "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. + "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. + }, + }, + "apiSpec": "A String", # The API spec that the external API implements. + "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. + "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. + "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + "apiKeyString": "A String", # Optional. The API key to be used in the request directly. + "httpElementLocation": "A String", # Optional. The location of the API key. + "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + }, + "authType": "A String", # Type of auth scheme. + "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. + "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + }, + "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. + "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + }, + "oauthConfig": { # Config for user oauth. # Config for user oauth. + "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + }, + "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. + "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + }, + }, + "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. + "index": "A String", # The ElasticSearch index to use. + "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. + "searchTemplate": "A String", # The ElasticSearch search template to use. + }, + "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search + "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. + }, + }, + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. + { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec + "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + ], + "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + "filter": "A String", # Optional. Filter strings to be passed to the search API. + "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. + }, + "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. + "ragCorpora": [ # Optional. Deprecated. Please use rag_resources instead. + "A String", + ], + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "hybridSearch": { # Config for Hybrid Search. # Optional. Config for Hybrid Search. + "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. The range is [0, 1], while 0 means sparse vector search only and 1 means dense vector search only. The default value is 0.5 which balances sparse and dense vector search equally. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. + "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + }, + "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` + }, + }, + "topK": 42, # Optional. The number of contexts to retrieve. + }, + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "storeContext": True or False, # Optional. Currently only supported for Gemini Multimodal Live API. In Gemini Multimodal Live API, if `store_context` bool is specified, Gemini will leverage it to automatically memorize the interactions between the client and Gemini, and retrieve context when needed to augment the response generation for users' ongoing and future interactions. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, + }, + ], + }, + }, + "turns": [ # Optional. A chronological list of conversation turns. Each turn represents a logical execution cycle (e.g., User Input -> Agent Response). + { # Represents a single turn/invocation in the conversation. + "events": [ # Optional. The list of events that occurred during this turn. + { # Represents a single event in the execution trace. + "activeTools": [ # Optional. The list of tools that were active/available to the agent at the time of this event. This overrides the `AgentConfig.tools` if set. + { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. + }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, + "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. + "A String", + ], + }, + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. + "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1beta1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. + "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1beta1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. + }, + ], + "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. If true, include the widget context token in the response. + }, + "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. + "A String", + ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, + }, + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. + "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. + "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. + "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. + }, + }, + "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation + "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more details. + "customConfigs": { # Optional. Custom configs for ParallelAiSearch. This field can be used to pass any parameter from the Parallel.ai Search API. See the Parallel.ai documentation for the full list of available parameters and their usage: https://docs.parallel.ai/api-reference/search-beta/search Currently only `source_policy`, `excerpts`, `max_results`, `mode`, `fetch_policy` can be set via this field. For example: { "source_policy": { "include_domains": ["google.com", "wikipedia.org"], "exclude_domains": ["example.com"] }, "fetch_policy": { "max_age_seconds": 3600 } } + "a_key": "", # Properties of the object. + }, + }, + "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. + "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported. + "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. + "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. + }, + }, + "apiSpec": "A String", # The API spec that the external API implements. + "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. + "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. + "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + "apiKeyString": "A String", # Optional. The API key to be used in the request directly. + "httpElementLocation": "A String", # Optional. The location of the API key. + "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + }, + "authType": "A String", # Type of auth scheme. + "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. + "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + }, + "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. + "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + }, + "oauthConfig": { # Config for user oauth. # Config for user oauth. + "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + }, + "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. + "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + }, + }, + "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. + "index": "A String", # The ElasticSearch index to use. + "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. + "searchTemplate": "A String", # The ElasticSearch search template to use. + }, + "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search + "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. + }, + }, + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. + { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec + "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + ], + "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + "filter": "A String", # Optional. Filter strings to be passed to the search API. + "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. + }, + "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. + "ragCorpora": [ # Optional. Deprecated. Please use rag_resources instead. + "A String", + ], + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "hybridSearch": { # Config for Hybrid Search. # Optional. Config for Hybrid Search. + "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. The range is [0, 1], while 0 means sparse vector search only and 1 means dense vector search only. The default value is 0.5 which balances sparse and dense vector search equally. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. + "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + }, + "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` + }, + }, + "topK": 42, # Optional. The number of contexts to retrieve. + }, + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "storeContext": True or False, # Optional. Currently only supported for Gemini Multimodal Live API. In Gemini Multimodal Live API, if `store_context` bool is specified, Gemini will leverage it to automatically memorize the interactions between the client and Gemini, and retrieve context when needed to augment the response generation for users' ongoing and future interactions. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, + }, + ], + "author": "A String", # Required. The ID of the agent or entity that generated this event. Use "user" to denote events generated by the end-user. + "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. + "code": "A String", # Required. The code to be executed. + "language": "A String", # Required. Programming language of the `code`. + }, + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "functionCall": { # A predicted FunctionCall returned from the model that contains a string representing the FunctionDeclaration.name and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. + "a_key": "", # Properties of the object. + }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. + "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. + "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. + { # Partial argument value of the function call. + "boolValue": True or False, # Optional. Represents a boolean value. + "jsonPath": "A String", # Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data". + "nullValue": "A String", # Optional. Represents a null value. + "numberValue": 3.14, # Optional. Represents a double value. + "stringValue": "A String", # Optional. Represents a string value. + "willContinue": True or False, # Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow. + }, + ], + "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. + }, + "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. + "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. + "a_key": "", # Properties of the object. + }, + "scheduling": "A String", # Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE. + }, + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. + "level": "A String", # The tokenization quality used for given media. + }, + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "endOffset": "A String", # Optional. The end offset of the video. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + "eventTime": "A String", # Optional. The timestamp when the event occurred. + "stateDelta": { # Optional. The change in the session state caused by this event. This is a key-value map of fields that were modified or added by the event. + "a_key": "", # Properties of the object. + }, + }, + ], + "turnId": "A String", # Optional. A unique identifier for the turn. Useful for referencing specific turns across systems. + "turnIndex": 42, # Required. The 0-based index of the turn in the conversation sequence. + }, + ], + }, + "candidate": "A String", # Required. The name of the candidate that produced the response. + "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). # Output only. Error while scraping model or agent. + "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. + }, + "events": [ # Optional. Intermediate events (such as tool calls and responses) that led to the final response. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. + "code": "A String", # Required. The code to be executed. + "language": "A String", # Required. Programming language of the `code`. + }, + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "functionCall": { # A predicted FunctionCall returned from the model that contains a string representing the FunctionDeclaration.name and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. + "a_key": "", # Properties of the object. + }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. + "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. + "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. + { # Partial argument value of the function call. + "boolValue": True or False, # Optional. Represents a boolean value. + "jsonPath": "A String", # Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data". + "nullValue": "A String", # Optional. Represents a null value. + "numberValue": 3.14, # Optional. Represents a double value. + "stringValue": "A String", # Optional. Represents a string value. + "willContinue": True or False, # Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow. + }, + ], + "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. + }, + "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. + "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. + "a_key": "", # Properties of the object. + }, + "scheduling": "A String", # Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE. + }, + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. + "level": "A String", # The tokenization quality used for given media. + }, + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "endOffset": "A String", # Optional. The end offset of the video. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + ], + "text": "A String", # Text response. + "value": "", # Fields and values that can be used to populate the response template. + }, + "prompt": { # Prompt to be evaluated. This can represent a single-turn prompt or a multi-turn conversation for agent evaluations. # Optional. The request/prompt to evaluate. + "agentData": { # Represents data specific to multi-turn agent evaluations. # Optional. Represents the complete execution trace of a multi-turn conversation, which can involve single or multiple agents. This serves as the input context for agent scraping. + "agents": { # Optional. A map containing the static configurations for each agent in the system. Key: agent_id (matches the `author` field in events). Value: The static configuration of the agent. + "a_key": { # Represents configuration for an Agent. + "agentId": "A String", # Required. Unique identifier of the agent. This ID is used to refer to this agent, e.g., in AgentEvent.author, or in the `sub_agents` field. It must be unique within the `agents` map. + "agentType": "A String", # Optional. The type or class of the agent (e.g., "LlmAgent", "RouterAgent", "ToolUseAgent"). Useful for the autorater to understand the expected behavior of the agent. + "description": "A String", # Optional. A high-level description of the agent's role and responsibilities. Critical for evaluating if the agent is routing tasks correctly. + "instruction": "A String", # Optional. Provides instructions for the LLM model, guiding the agent's behavior. Can be static or dynamic. Dynamic instructions can contain placeholders like {variable_name} that will be resolved at runtime using the `AgentEvent.state_delta` field. + "subAgents": [ # Optional. The list of valid agent IDs that this agent can delegate to. This defines the directed edges in the multi-agent system graph topology. + "A String", + ], + "tools": [ # Optional. The list of tools available to this agent. + { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. + }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, + "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. + "A String", + ], + }, + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. + "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1beta1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. + "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1beta1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. + }, + ], + "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. If true, include the widget context token in the response. + }, + "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. + "A String", + ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, + }, + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. + "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. + "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. + "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. + }, + }, + "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation + "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more details. + "customConfigs": { # Optional. Custom configs for ParallelAiSearch. This field can be used to pass any parameter from the Parallel.ai Search API. See the Parallel.ai documentation for the full list of available parameters and their usage: https://docs.parallel.ai/api-reference/search-beta/search Currently only `source_policy`, `excerpts`, `max_results`, `mode`, `fetch_policy` can be set via this field. For example: { "source_policy": { "include_domains": ["google.com", "wikipedia.org"], "exclude_domains": ["example.com"] }, "fetch_policy": { "max_age_seconds": 3600 } } + "a_key": "", # Properties of the object. + }, + }, + "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. + "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported. + "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. + "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. + }, + }, + "apiSpec": "A String", # The API spec that the external API implements. + "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. + "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. + "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + "apiKeyString": "A String", # Optional. The API key to be used in the request directly. + "httpElementLocation": "A String", # Optional. The location of the API key. + "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + }, + "authType": "A String", # Type of auth scheme. + "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. + "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + }, + "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. + "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + }, + "oauthConfig": { # Config for user oauth. # Config for user oauth. + "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + }, + "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. + "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + }, + }, + "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. + "index": "A String", # The ElasticSearch index to use. + "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. + "searchTemplate": "A String", # The ElasticSearch search template to use. + }, + "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search + "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. + }, + }, + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. + { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec + "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + ], + "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + "filter": "A String", # Optional. Filter strings to be passed to the search API. + "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. + }, + "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. + "ragCorpora": [ # Optional. Deprecated. Please use rag_resources instead. + "A String", + ], + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "hybridSearch": { # Config for Hybrid Search. # Optional. Config for Hybrid Search. + "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. The range is [0, 1], while 0 means sparse vector search only and 1 means dense vector search only. The default value is 0.5 which balances sparse and dense vector search equally. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. + "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + }, + "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` + }, + }, + "topK": 42, # Optional. The number of contexts to retrieve. + }, + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "storeContext": True or False, # Optional. Currently only supported for Gemini Multimodal Live API. In Gemini Multimodal Live API, if `store_context` bool is specified, Gemini will leverage it to automatically memorize the interactions between the client and Gemini, and retrieve context when needed to augment the response generation for users' ongoing and future interactions. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, + }, + ], + }, + }, + "turns": [ # Optional. A chronological list of conversation turns. Each turn represents a logical execution cycle (e.g., User Input -> Agent Response). + { # Represents a single turn/invocation in the conversation. + "events": [ # Optional. The list of events that occurred during this turn. + { # Represents a single event in the execution trace. + "activeTools": [ # Optional. The list of tools that were active/available to the agent at the time of this event. This overrides the `AgentConfig.tools` if set. + { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. + }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, + "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. + "A String", + ], + }, + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. + "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1beta1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. + "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1beta1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. + }, + ], + "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. If true, include the widget context token in the response. + }, + "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. + "A String", + ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, + }, + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. + "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. + "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. + "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. + }, + }, + "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation + "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more details. + "customConfigs": { # Optional. Custom configs for ParallelAiSearch. This field can be used to pass any parameter from the Parallel.ai Search API. See the Parallel.ai documentation for the full list of available parameters and their usage: https://docs.parallel.ai/api-reference/search-beta/search Currently only `source_policy`, `excerpts`, `max_results`, `mode`, `fetch_policy` can be set via this field. For example: { "source_policy": { "include_domains": ["google.com", "wikipedia.org"], "exclude_domains": ["example.com"] }, "fetch_policy": { "max_age_seconds": 3600 } } + "a_key": "", # Properties of the object. + }, + }, + "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. + "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported. + "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. + "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. + }, + }, + "apiSpec": "A String", # The API spec that the external API implements. + "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. + "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. + "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + "apiKeyString": "A String", # Optional. The API key to be used in the request directly. + "httpElementLocation": "A String", # Optional. The location of the API key. + "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + }, + "authType": "A String", # Type of auth scheme. + "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. + "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + }, + "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. + "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + }, + "oauthConfig": { # Config for user oauth. # Config for user oauth. + "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + }, + "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. + "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + }, + }, + "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. + "index": "A String", # The ElasticSearch index to use. + "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. + "searchTemplate": "A String", # The ElasticSearch search template to use. + }, + "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search + "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. + }, + }, + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. + { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec + "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + ], + "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + "filter": "A String", # Optional. Filter strings to be passed to the search API. + "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. + }, + "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. + "ragCorpora": [ # Optional. Deprecated. Please use rag_resources instead. + "A String", + ], + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "hybridSearch": { # Config for Hybrid Search. # Optional. Config for Hybrid Search. + "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. The range is [0, 1], while 0 means sparse vector search only and 1 means dense vector search only. The default value is 0.5 which balances sparse and dense vector search equally. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. + "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + }, + "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` + }, + }, + "topK": 42, # Optional. The number of contexts to retrieve. + }, + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "storeContext": True or False, # Optional. Currently only supported for Gemini Multimodal Live API. In Gemini Multimodal Live API, if `store_context` bool is specified, Gemini will leverage it to automatically memorize the interactions between the client and Gemini, and retrieve context when needed to augment the response generation for users' ongoing and future interactions. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, + }, + ], + "author": "A String", # Required. The ID of the agent or entity that generated this event. Use "user" to denote events generated by the end-user. + "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. + "code": "A String", # Required. The code to be executed. + "language": "A String", # Required. Programming language of the `code`. + }, + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "functionCall": { # A predicted FunctionCall returned from the model that contains a string representing the FunctionDeclaration.name and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. + "a_key": "", # Properties of the object. + }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. + "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. + "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. + { # Partial argument value of the function call. + "boolValue": True or False, # Optional. Represents a boolean value. + "jsonPath": "A String", # Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data". + "nullValue": "A String", # Optional. Represents a null value. + "numberValue": 3.14, # Optional. Represents a double value. + "stringValue": "A String", # Optional. Represents a string value. + "willContinue": True or False, # Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow. + }, + ], + "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. + }, + "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. + "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. + "a_key": "", # Properties of the object. + }, + "scheduling": "A String", # Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE. + }, + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. + "level": "A String", # The tokenization quality used for given media. + }, + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "endOffset": "A String", # Optional. The end offset of the video. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + "eventTime": "A String", # Optional. The timestamp when the event occurred. + "stateDelta": { # Optional. The change in the session state caused by this event. This is a key-value map of fields that were modified or added by the event. + "a_key": "", # Properties of the object. + }, + }, + ], + "turnId": "A String", # Optional. A unique identifier for the turn. Useful for referencing specific turns across systems. + "turnIndex": 42, # Required. The 0-based index of the turn in the conversation sequence. + }, + ], + }, + "promptTemplateData": { # Message to hold a prompt template and the values to populate the template. # Prompt template data. + "values": { # The values for fields in the prompt template. + "a_key": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. + "code": "A String", # Required. The code to be executed. + "language": "A String", # Required. Programming language of the `code`. + }, + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "functionCall": { # A predicted FunctionCall returned from the model that contains a string representing the FunctionDeclaration.name and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. + "a_key": "", # Properties of the object. + }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. + "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. + "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. + { # Partial argument value of the function call. + "boolValue": True or False, # Optional. Represents a boolean value. + "jsonPath": "A String", # Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data". + "nullValue": "A String", # Optional. Represents a null value. + "numberValue": 3.14, # Optional. Represents a double value. + "stringValue": "A String", # Optional. Represents a string value. + "willContinue": True or False, # Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow. + }, + ], + "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. + }, + "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. + "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. + "a_key": "", # Properties of the object. + }, + "scheduling": "A String", # Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE. + }, + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. + "level": "A String", # The tokenization quality used for given media. + }, + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "endOffset": "A String", # Optional. The end offset of the video. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + }, + }, + "text": "A String", # Text prompt. + "userScenario": { # User scenario to help simulate multi-turn agent running results. # Optional. The generated user scenario used to drive multi-turn agent running results. + "conversationPlan": "A String", # Required. The plan for the conversation, used to drive the multi-turn agent run and generate the simulated agent evaluation dataset. + "startingPrompt": "A String", # Required. The prompt that starts the conversation between the simulated user and the agent under test. + }, + "value": "", # Fields and values that can be used to populate the prompt template. + }, + "rubrics": { # Optional. Named groups of rubrics associated with this prompt. The key is a user-defined name for the rubric group. + "a_key": { # A group of rubrics, used for grouping rubrics based on a metric or a version. + "displayName": "A String", # Human-readable name for the group. This should be unique within a given context if used for display or selection. Example: "Instruction Following V1", "Content Quality - Summarization Task". + "groupId": "A String", # Unique identifier for the group. + "rubrics": [ # Rubrics that are part of this group. + { # Message representing a single testable criterion for evaluation. One input prompt could have multiple rubrics. + "content": { # Content of the rubric, defining the testable criteria. # Required. The actual testable criteria for the rubric. + "property": { # Defines criteria based on a specific property. # Evaluation criteria based on a specific property. + "description": "A String", # Description of the property being evaluated. Example: "The model's response is grammatically correct." + }, + }, + "importance": "A String", # Optional. The relative importance of this rubric. + "rubricId": "A String", # Unique identifier for the rubric. This ID is used to refer to this rubric, e.g., in RubricVerdict. + "type": "A String", # Optional. A type designator for the rubric, which can inform how it's evaluated or interpreted by systems or users. It's recommended to use consistent, well-defined, upper snake_case strings. Examples: "SUMMARIZATION_QUALITY", "SAFETY_HARMFUL_CONTENT", "INSTRUCTION_ADHERENCE". + }, + ], + }, + }, + }, + }, + "failedRubrics": [ # The specific rubric(s) that failed and caused this example to be classified here. An example might fail multiple rubrics, but only specific ones trigger this loss pattern. + { # Represents a specific failed rubric and the associated analysis. + "classificationRationale": "A String", # The rationale provided by the Loss Analysis Classifier for why this failure maps to this specific Loss Cluster. e.g., "The agent claimed an action without a tool call, matching 'Hallucination of Action'." + "rubricId": "A String", # The unique ID of the rubric (if available from the metric source). Clients use this ID to query the corresponding rubric verdict. + }, + ], + }, + ], + "itemCount": 42, # The total number of EvaluationItems falling into this cluster. + "taxonomyEntry": { # Defines a specific entry in the loss pattern taxonomy. # The structured definition of the loss taxonomy for this cluster. + "description": "A String", # A detailed description of this loss pattern. Example: "The agent verbally confirms an action without executing the tool." + "l1Category": "A String", # The primary category of the loss (e.g., "Hallucination", "Tool Calling"). This field is typically required. + "l2Category": "A String", # The secondary category of the loss (e.g., "Hallucination of Action", "Incorrect Tool Selection"). + }, + }, + ], + "config": { # Configuration for the loss analysis job. # The configuration used to generate this analysis. + "candidate": "A String", # Required. The candidate model/agent to analyze (e.g., "gemini-3.0-pro"). This targets the specific CandidateResult within the EvaluationResult. + "metric": "A String", # Required. The metric to analyze (e.g., "tool_use_quality"). This filters the EvaluationItems in the EvalSet to only those where EvaluationResult.metric matches this value. + }, + }, + ], "summaryMetrics": { # The summary metrics for the evaluation run. # Optional. The summary metrics for the evaluation run. "failedItems": 42, # Optional. The number of items that failed to be evaluated. "metrics": { # Optional. Map of metric name to metric value. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.html index d69f9d1e81..0ee2866565 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.html @@ -239,6 +239,11 @@

Instance Methods

Returns the notebookRuntimes Resource.

+

+ onlineEvaluators() +

+

Returns the onlineEvaluators Resource.

+

operations()

@@ -344,6 +349,9 @@

Instance Methods

generateInstanceRubrics(location, body=None, x__xgafv=None)

Generates rubrics for a given prompt. A rubric represents a single testable criterion for evaluation. One input prompt could have multiple rubrics This RPC allows users to get suggested rubrics based on provided prompt, which can then be reviewed and used for subsequent evaluations.

+

+ generateLossClusters(location, body=None, x__xgafv=None)

+

Generates loss clusters from evaluation results. This is a statelss API method that would not modify the EvaluationSet resource.

generateSyntheticData(location, body=None, x__xgafv=None)

Generates synthetic (artificial) data based on a description

@@ -6592,6 +6600,2033 @@

Method Details

}
+
+ generateLossClusters(location, body=None, x__xgafv=None) +
Generates loss clusters from evaluation results. This is a statelss API method that would not modify the EvaluationSet resource.
+
+Args:
+  location: string, Required. The resource name of the Location. Format: `projects/{project}/locations/{location}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for EvaluationAnalyticsService.GenerateLossClusters.
+  "configs": [ # Required. Configuration for the analysis algorithm. Analysis for multiple metrics and multiple candidates could be specified.
+    { # Configuration for the loss analysis job.
+      "candidate": "A String", # Required. The candidate model/agent to analyze (e.g., "gemini-3.0-pro"). This targets the specific CandidateResult within the EvaluationResult.
+      "metric": "A String", # Required. The metric to analyze (e.g., "tool_use_quality"). This filters the EvaluationItems in the EvalSet to only those where EvaluationResult.metric matches this value.
+    },
+  ],
+  "evaluationSet": "A String", # Reference to a persisted EvaluationSet. The service will read items from this set.
+  "inlineResults": { # A wrapper to allow providing a list of items inline. # Inline evaluation results. Useful for ephemeral analysis in notebooks/SDKs where data isn't persisted.
+    "evaluationResults": [ # Required. The list of evaluation results to analyze.
+      { # Evaluation result.
+        "candidateResults": [ # Optional. The results for the metric.
+          { # Result for a single candidate.
+            "additionalResults": "", # Optional. Additional results for the metric.
+            "candidate": "A String", # Required. The candidate that is being evaluated. The value is the same as the candidate name in the EvaluationRequest.
+            "explanation": "A String", # Optional. The explanation for the metric.
+            "metric": "A String", # Required. The metric that was evaluated.
+            "rubricVerdicts": [ # Optional. The rubric verdicts for the metric.
+              { # Represents the verdict of an evaluation against a single rubric.
+                "evaluatedRubric": { # Message representing a single testable criterion for evaluation. One input prompt could have multiple rubrics. # Required. The full rubric definition that was evaluated. Storing this ensures the verdict is self-contained and understandable, especially if the original rubric definition changes or was dynamically generated.
+                  "content": { # Content of the rubric, defining the testable criteria. # Required. The actual testable criteria for the rubric.
+                    "property": { # Defines criteria based on a specific property. # Evaluation criteria based on a specific property.
+                      "description": "A String", # Description of the property being evaluated. Example: "The model's response is grammatically correct."
+                    },
+                  },
+                  "importance": "A String", # Optional. The relative importance of this rubric.
+                  "rubricId": "A String", # Unique identifier for the rubric. This ID is used to refer to this rubric, e.g., in RubricVerdict.
+                  "type": "A String", # Optional. A type designator for the rubric, which can inform how it's evaluated or interpreted by systems or users. It's recommended to use consistent, well-defined, upper snake_case strings. Examples: "SUMMARIZATION_QUALITY", "SAFETY_HARMFUL_CONTENT", "INSTRUCTION_ADHERENCE".
+                },
+                "reasoning": "A String", # Optional. Human-readable reasoning or explanation for the verdict. This can include specific examples or details from the evaluated content that justify the given verdict.
+                "verdict": True or False, # Required. Outcome of the evaluation against the rubric, represented as a boolean. `true` indicates a "Pass", `false` indicates a "Fail".
+              },
+            ],
+            "score": 3.14, # Optional. The score for the metric.
+          },
+        ],
+        "evaluationRequest": "A String", # Required. The request item that was evaluated. Format: projects/{project}/locations/{location}/evaluationItems/{evaluation_item}
+        "evaluationRun": "A String", # Required. The evaluation run that was used to generate the result. Format: projects/{project}/locations/{location}/evaluationRuns/{evaluation_run}
+        "metadata": "", # Optional. Metadata about the evaluation result.
+        "metric": "A String", # Required. The metric that was evaluated.
+        "request": { # A single evaluation request supporting input for both single-turn model generation and multi-turn agent execution traces. Valid input modes: 1. Inference Mode: `prompt` is set (containing text or AgentData context). 2. Offline Eval Mode: `prompt` is unset, and `candidate_responses` contains `agent_data` (the completed execution trace). Validation Rule: Either `prompt` must be set, OR at least one of the `candidate_responses` must contain `agent_data`. # Required. The request that was evaluated.
+          "candidateResponses": [ # Optional. Responses from model under test and other baseline models for comparison.
+            { # Responses from model or agent.
+              "agentData": { # Represents data specific to multi-turn agent evaluations. # Optional. Represents the complete execution trace of a multi-turn conversation, which can involve single or multiple agents. This field is used to provide the full output of an agent's run, including all turns and events, for direct evaluation.
+                "agents": { # Optional. A map containing the static configurations for each agent in the system. Key: agent_id (matches the `author` field in events). Value: The static configuration of the agent.
+                  "a_key": { # Represents configuration for an Agent.
+                    "agentId": "A String", # Required. Unique identifier of the agent. This ID is used to refer to this agent, e.g., in AgentEvent.author, or in the `sub_agents` field. It must be unique within the `agents` map.
+                    "agentType": "A String", # Optional. The type or class of the agent (e.g., "LlmAgent", "RouterAgent", "ToolUseAgent"). Useful for the autorater to understand the expected behavior of the agent.
+                    "description": "A String", # Optional. A high-level description of the agent's role and responsibilities. Critical for evaluating if the agent is routing tasks correctly.
+                    "instruction": "A String", # Optional. Provides instructions for the LLM model, guiding the agent's behavior. Can be static or dynamic. Dynamic instructions can contain placeholders like {variable_name} that will be resolved at runtime using the `AgentEvent.state_delta` field.
+                    "subAgents": [ # Optional. The list of valid agent IDs that this agent can delegate to. This defines the directed edges in the multi-agent system graph topology.
+                      "A String",
+                    ],
+                    "tools": [ # Optional. The list of tools available to this agent.
+                      { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval).
+                        "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation.
+                        },
+                        "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations.
+                          "environment": "A String", # Required. The environment being operated.
+                          "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions.
+                            "A String",
+                          ],
+                        },
+                        "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance.
+                          "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
+                          "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains.
+                            "A String",
+                          ],
+                        },
+                        "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided.
+                          { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client.
+                            "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function.
+                            "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128.
+                            "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1
+                              "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema.
+                              "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`.
+                                # Object with schema name: GoogleCloudAiplatformV1beta1Schema
+                              ],
+                              "default": "", # Optional. Default value to use if the field is not specified.
+                              "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema.
+                                "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
+                              },
+                              "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt.
+                              "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}`
+                                "A String",
+                              ],
+                              "example": "", # Optional. Example of an instance of this schema.
+                              "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type.
+                              "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array.
+                              "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array.
+                              "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string.
+                              "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided.
+                              "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value.
+                              "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array.
+                              "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string.
+                              "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided.
+                              "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value.
+                              "nullable": True or False, # Optional. Indicates if the value of this field can be null.
+                              "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match.
+                              "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object.
+                                "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
+                              },
+                              "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties.
+                                "A String",
+                              ],
+                              "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring
+                              "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present.
+                                "A String",
+                              ],
+                              "title": "A String", # Optional. Title for the schema.
+                              "type": "A String", # Optional. Data type of the schema field.
+                            },
+                            "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`.
+                            "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function.
+                              "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema.
+                              "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`.
+                                # Object with schema name: GoogleCloudAiplatformV1beta1Schema
+                              ],
+                              "default": "", # Optional. Default value to use if the field is not specified.
+                              "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema.
+                                "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
+                              },
+                              "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt.
+                              "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}`
+                                "A String",
+                              ],
+                              "example": "", # Optional. Example of an instance of this schema.
+                              "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type.
+                              "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array.
+                              "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array.
+                              "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string.
+                              "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided.
+                              "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value.
+                              "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array.
+                              "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string.
+                              "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided.
+                              "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value.
+                              "nullable": True or False, # Optional. Indicates if the value of this field can be null.
+                              "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match.
+                              "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object.
+                                "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
+                              },
+                              "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties.
+                                "A String",
+                              ],
+                              "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring
+                              "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present.
+                                "A String",
+                              ],
+                              "title": "A String", # Optional. Title for the schema.
+                              "type": "A String", # Optional. Data type of the schema field.
+                            },
+                            "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`.
+                          },
+                        ],
+                        "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model.
+                          "enableWidget": True or False, # Optional. If true, include the widget context token in the response.
+                        },
+                        "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google.
+                          "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
+                          "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"].
+                            "A String",
+                          ],
+                          "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default.
+                            "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned.
+                            },
+                            "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned.
+                            },
+                          },
+                        },
+                        "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search.
+                          "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source.
+                            "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used.
+                            "mode": "A String", # The mode of the predictor to be used in dynamic retrieval.
+                          },
+                        },
+                        "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation
+                          "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more details.
+                          "customConfigs": { # Optional. Custom configs for ParallelAiSearch. This field can be used to pass any parameter from the Parallel.ai Search API. See the Parallel.ai documentation for the full list of available parameters and their usage: https://docs.parallel.ai/api-reference/search-beta/search Currently only `source_policy`, `excerpts`, `max_results`, `mode`, `fetch_policy` can be set via this field. For example: { "source_policy": { "include_domains": ["google.com", "wikipedia.org"], "exclude_domains": ["example.com"] }, "fetch_policy": { "max_age_seconds": 3600 } }
+                            "a_key": "", # Properties of the object.
+                          },
+                        },
+                        "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation.
+                          "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported.
+                          "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding.
+                            "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead.
+                              "apiKeyConfig": { # The API secret. # The API secret.
+                                "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version}
+                                "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set.
+                              },
+                            },
+                            "apiSpec": "A String", # The API spec that the external API implements.
+                            "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API.
+                              "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth.
+                                "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource.
+                                "apiKeyString": "A String", # Optional. The API key to be used in the request directly.
+                                "httpElementLocation": "A String", # Optional. The location of the API key.
+                                "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name.
+                              },
+                              "authType": "A String", # Type of auth scheme.
+                              "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth.
+                                "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension.
+                              },
+                              "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth.
+                                "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource.
+                              },
+                              "oauthConfig": { # Config for user oauth. # Config for user oauth.
+                                "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time.
+                                "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account.
+                              },
+                              "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth.
+                                "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time.
+                                "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents).
+                              },
+                            },
+                            "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API.
+                              "index": "A String", # The ElasticSearch index to use.
+                              "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param.
+                              "searchTemplate": "A String", # The ElasticSearch search template to use.
+                            },
+                            "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search
+                            "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API.
+                            },
+                          },
+                          "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search.
+                            "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used.
+                              { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec
+                                "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
+                                "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
+                              },
+                            ],
+                            "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
+                            "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`
+                            "filter": "A String", # Optional. Filter strings to be passed to the search API.
+                            "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10.
+                          },
+                          "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService.
+                            "ragCorpora": [ # Optional. Deprecated. Please use rag_resources instead.
+                              "A String",
+                            ],
+                            "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support.
+                              { # The definition of the Rag resource.
+                                "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`
+                                "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field.
+                                  "A String",
+                                ],
+                              },
+                            ],
+                            "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query.
+                              "filter": { # Config for filters. # Optional. Config for filters.
+                                "metadataFilter": "A String", # Optional. String for metadata filtering.
+                                "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold.
+                                "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold.
+                              },
+                              "hybridSearch": { # Config for Hybrid Search. # Optional. Config for Hybrid Search.
+                                "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. The range is [0, 1], while 0 means sparse vector search only and 1 means dense vector search only. The default value is 0.5 which balances sparse and dense vector search equally.
+                              },
+                              "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking.
+                                "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker.
+                                  "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).
+                                },
+                                "rankService": { # Config for Rank Service. # Optional. Config for Rank Service.
+                                  "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest`
+                                },
+                              },
+                              "topK": 42, # Optional. The number of contexts to retrieve.
+                            },
+                            "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora.
+                            "storeContext": True or False, # Optional. Currently only supported for Gemini Multimodal Live API. In Gemini Multimodal Live API, if `store_context` bool is specified, Gemini will leverage it to automatically memorize the interactions between the client and Gemini, and retrieve context when needed to augment the response generation for users' ongoing and future interactions.
+                            "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold.
+                          },
+                        },
+                        "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval.
+                        },
+                      },
+                    ],
+                  },
+                },
+                "turns": [ # Optional. A chronological list of conversation turns. Each turn represents a logical execution cycle (e.g., User Input -> Agent Response).
+                  { # Represents a single turn/invocation in the conversation.
+                    "events": [ # Optional. The list of events that occurred during this turn.
+                      { # Represents a single event in the execution trace.
+                        "activeTools": [ # Optional. The list of tools that were active/available to the agent at the time of this event. This overrides the `AgentConfig.tools` if set.
+                          { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval).
+                            "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation.
+                            },
+                            "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations.
+                              "environment": "A String", # Required. The environment being operated.
+                              "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions.
+                                "A String",
+                              ],
+                            },
+                            "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance.
+                              "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
+                              "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains.
+                                "A String",
+                              ],
+                            },
+                            "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided.
+                              { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client.
+                                "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function.
+                                "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128.
+                                "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1
+                                  "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema.
+                                  "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`.
+                                    # Object with schema name: GoogleCloudAiplatformV1beta1Schema
+                                  ],
+                                  "default": "", # Optional. Default value to use if the field is not specified.
+                                  "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema.
+                                    "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
+                                  },
+                                  "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt.
+                                  "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}`
+                                    "A String",
+                                  ],
+                                  "example": "", # Optional. Example of an instance of this schema.
+                                  "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type.
+                                  "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array.
+                                  "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array.
+                                  "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string.
+                                  "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided.
+                                  "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value.
+                                  "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array.
+                                  "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string.
+                                  "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided.
+                                  "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value.
+                                  "nullable": True or False, # Optional. Indicates if the value of this field can be null.
+                                  "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match.
+                                  "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object.
+                                    "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
+                                  },
+                                  "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties.
+                                    "A String",
+                                  ],
+                                  "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring
+                                  "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present.
+                                    "A String",
+                                  ],
+                                  "title": "A String", # Optional. Title for the schema.
+                                  "type": "A String", # Optional. Data type of the schema field.
+                                },
+                                "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`.
+                                "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function.
+                                  "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema.
+                                  "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`.
+                                    # Object with schema name: GoogleCloudAiplatformV1beta1Schema
+                                  ],
+                                  "default": "", # Optional. Default value to use if the field is not specified.
+                                  "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema.
+                                    "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
+                                  },
+                                  "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt.
+                                  "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}`
+                                    "A String",
+                                  ],
+                                  "example": "", # Optional. Example of an instance of this schema.
+                                  "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type.
+                                  "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array.
+                                  "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array.
+                                  "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string.
+                                  "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided.
+                                  "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value.
+                                  "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array.
+                                  "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string.
+                                  "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided.
+                                  "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value.
+                                  "nullable": True or False, # Optional. Indicates if the value of this field can be null.
+                                  "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match.
+                                  "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object.
+                                    "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
+                                  },
+                                  "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties.
+                                    "A String",
+                                  ],
+                                  "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring
+                                  "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present.
+                                    "A String",
+                                  ],
+                                  "title": "A String", # Optional. Title for the schema.
+                                  "type": "A String", # Optional. Data type of the schema field.
+                                },
+                                "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`.
+                              },
+                            ],
+                            "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model.
+                              "enableWidget": True or False, # Optional. If true, include the widget context token in the response.
+                            },
+                            "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google.
+                              "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
+                              "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"].
+                                "A String",
+                              ],
+                              "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default.
+                                "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned.
+                                },
+                                "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned.
+                                },
+                              },
+                            },
+                            "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search.
+                              "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source.
+                                "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used.
+                                "mode": "A String", # The mode of the predictor to be used in dynamic retrieval.
+                              },
+                            },
+                            "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation
+                              "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more details.
+                              "customConfigs": { # Optional. Custom configs for ParallelAiSearch. This field can be used to pass any parameter from the Parallel.ai Search API. See the Parallel.ai documentation for the full list of available parameters and their usage: https://docs.parallel.ai/api-reference/search-beta/search Currently only `source_policy`, `excerpts`, `max_results`, `mode`, `fetch_policy` can be set via this field. For example: { "source_policy": { "include_domains": ["google.com", "wikipedia.org"], "exclude_domains": ["example.com"] }, "fetch_policy": { "max_age_seconds": 3600 } }
+                                "a_key": "", # Properties of the object.
+                              },
+                            },
+                            "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation.
+                              "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported.
+                              "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding.
+                                "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead.
+                                  "apiKeyConfig": { # The API secret. # The API secret.
+                                    "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version}
+                                    "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set.
+                                  },
+                                },
+                                "apiSpec": "A String", # The API spec that the external API implements.
+                                "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API.
+                                  "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth.
+                                    "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource.
+                                    "apiKeyString": "A String", # Optional. The API key to be used in the request directly.
+                                    "httpElementLocation": "A String", # Optional. The location of the API key.
+                                    "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name.
+                                  },
+                                  "authType": "A String", # Type of auth scheme.
+                                  "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth.
+                                    "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension.
+                                  },
+                                  "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth.
+                                    "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource.
+                                  },
+                                  "oauthConfig": { # Config for user oauth. # Config for user oauth.
+                                    "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time.
+                                    "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account.
+                                  },
+                                  "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth.
+                                    "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time.
+                                    "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents).
+                                  },
+                                },
+                                "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API.
+                                  "index": "A String", # The ElasticSearch index to use.
+                                  "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param.
+                                  "searchTemplate": "A String", # The ElasticSearch search template to use.
+                                },
+                                "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search
+                                "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API.
+                                },
+                              },
+                              "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search.
+                                "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used.
+                                  { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec
+                                    "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
+                                    "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
+                                  },
+                                ],
+                                "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
+                                "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`
+                                "filter": "A String", # Optional. Filter strings to be passed to the search API.
+                                "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10.
+                              },
+                              "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService.
+                                "ragCorpora": [ # Optional. Deprecated. Please use rag_resources instead.
+                                  "A String",
+                                ],
+                                "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support.
+                                  { # The definition of the Rag resource.
+                                    "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`
+                                    "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field.
+                                      "A String",
+                                    ],
+                                  },
+                                ],
+                                "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query.
+                                  "filter": { # Config for filters. # Optional. Config for filters.
+                                    "metadataFilter": "A String", # Optional. String for metadata filtering.
+                                    "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold.
+                                    "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold.
+                                  },
+                                  "hybridSearch": { # Config for Hybrid Search. # Optional. Config for Hybrid Search.
+                                    "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. The range is [0, 1], while 0 means sparse vector search only and 1 means dense vector search only. The default value is 0.5 which balances sparse and dense vector search equally.
+                                  },
+                                  "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking.
+                                    "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker.
+                                      "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).
+                                    },
+                                    "rankService": { # Config for Rank Service. # Optional. Config for Rank Service.
+                                      "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest`
+                                    },
+                                  },
+                                  "topK": 42, # Optional. The number of contexts to retrieve.
+                                },
+                                "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora.
+                                "storeContext": True or False, # Optional. Currently only supported for Gemini Multimodal Live API. In Gemini Multimodal Live API, if `store_context` bool is specified, Gemini will leverage it to automatically memorize the interactions between the client and Gemini, and retrieve context when needed to augment the response generation for users' ongoing and future interactions.
+                                "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold.
+                              },
+                            },
+                            "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval.
+                            },
+                          },
+                        ],
+                        "author": "A String", # Required. The ID of the agent or entity that generated this event. Use "user" to denote events generated by the end-user.
+                        "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response).
+                          "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part.
+                            { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
+                              "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode.
+                                "outcome": "A String", # Required. Outcome of the code execution.
+                                "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise.
+                              },
+                              "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed.
+                                "code": "A String", # Required. The code to be executed.
+                                "language": "A String", # Required. Programming language of the `code`.
+                              },
+                              "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage.
+                                "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
+                                "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage.
+                                "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                              },
+                              "functionCall": { # A predicted FunctionCall returned from the model that contains a string representing the FunctionDeclaration.name and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function.
+                                "args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details.
+                                  "a_key": "", # Properties of the object.
+                                },
+                                "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`.
+                                "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name.
+                                "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally.
+                                  { # Partial argument value of the function call.
+                                    "boolValue": True or False, # Optional. Represents a boolean value.
+                                    "jsonPath": "A String", # Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data".
+                                    "nullValue": "A String", # Optional. Represents a null value.
+                                    "numberValue": 3.14, # Optional. Represents a double value.
+                                    "stringValue": "A String", # Optional. Represents a string value.
+                                    "willContinue": True or False, # Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow.
+                                  },
+                                ],
+                                "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow.
+                              },
+                              "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted.
+                                "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`.
+                                "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name.
+                                "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types.
+                                  { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes.
+                                    "fileData": { # URI based data for function response. # URI based data.
+                                      "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                                      "fileUri": "A String", # Required. URI.
+                                      "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                                    },
+                                    "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes.
+                                      "data": "A String", # Required. Raw bytes.
+                                      "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                                      "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                                    },
+                                  },
+                                ],
+                                "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output.
+                                  "a_key": "", # Properties of the object.
+                                },
+                                "scheduling": "A String", # Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE.
+                              },
+                              "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request.
+                                "data": "A String", # Required. The raw bytes of the data.
+                                "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
+                                "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                              },
+                              "mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media.
+                                "level": "A String", # The tokenization quality used for given media.
+                              },
+                              "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent.
+                              "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning.
+                              "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests.
+                              "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
+                                "endOffset": "A String", # Optional. The end offset of the video.
+                                "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0].
+                                "startOffset": "A String", # Optional. The start offset of the video.
+                              },
+                            },
+                          ],
+                          "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'.
+                        },
+                        "eventTime": "A String", # Optional. The timestamp when the event occurred.
+                        "stateDelta": { # Optional. The change in the session state caused by this event. This is a key-value map of fields that were modified or added by the event.
+                          "a_key": "", # Properties of the object.
+                        },
+                      },
+                    ],
+                    "turnId": "A String", # Optional. A unique identifier for the turn. Useful for referencing specific turns across systems.
+                    "turnIndex": 42, # Required. The 0-based index of the turn in the conversation sequence.
+                  },
+                ],
+              },
+              "candidate": "A String", # Required. The name of the candidate that produced the response.
+              "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). # Output only. Error while scraping model or agent.
+                "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.
+              },
+              "events": [ # Optional. Intermediate events (such as tool calls and responses) that led to the final response.
+                { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message.
+                  "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part.
+                    { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
+                      "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode.
+                        "outcome": "A String", # Required. Outcome of the code execution.
+                        "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise.
+                      },
+                      "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed.
+                        "code": "A String", # Required. The code to be executed.
+                        "language": "A String", # Required. Programming language of the `code`.
+                      },
+                      "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage.
+                        "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
+                        "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage.
+                        "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                      },
+                      "functionCall": { # A predicted FunctionCall returned from the model that contains a string representing the FunctionDeclaration.name and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function.
+                        "args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details.
+                          "a_key": "", # Properties of the object.
+                        },
+                        "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`.
+                        "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name.
+                        "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally.
+                          { # Partial argument value of the function call.
+                            "boolValue": True or False, # Optional. Represents a boolean value.
+                            "jsonPath": "A String", # Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data".
+                            "nullValue": "A String", # Optional. Represents a null value.
+                            "numberValue": 3.14, # Optional. Represents a double value.
+                            "stringValue": "A String", # Optional. Represents a string value.
+                            "willContinue": True or False, # Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow.
+                          },
+                        ],
+                        "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow.
+                      },
+                      "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted.
+                        "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`.
+                        "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name.
+                        "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types.
+                          { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes.
+                            "fileData": { # URI based data for function response. # URI based data.
+                              "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                              "fileUri": "A String", # Required. URI.
+                              "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                            },
+                            "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes.
+                              "data": "A String", # Required. Raw bytes.
+                              "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                              "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                            },
+                          },
+                        ],
+                        "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output.
+                          "a_key": "", # Properties of the object.
+                        },
+                        "scheduling": "A String", # Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE.
+                      },
+                      "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request.
+                        "data": "A String", # Required. The raw bytes of the data.
+                        "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
+                        "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                      },
+                      "mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media.
+                        "level": "A String", # The tokenization quality used for given media.
+                      },
+                      "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent.
+                      "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning.
+                      "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests.
+                      "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
+                        "endOffset": "A String", # Optional. The end offset of the video.
+                        "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0].
+                        "startOffset": "A String", # Optional. The start offset of the video.
+                      },
+                    },
+                  ],
+                  "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'.
+                },
+              ],
+              "text": "A String", # Text response.
+              "value": "", # Fields and values that can be used to populate the response template.
+            },
+          ],
+          "goldenResponse": { # Responses from model or agent. # Optional. The Ideal response or ground truth.
+            "agentData": { # Represents data specific to multi-turn agent evaluations. # Optional. Represents the complete execution trace of a multi-turn conversation, which can involve single or multiple agents. This field is used to provide the full output of an agent's run, including all turns and events, for direct evaluation.
+              "agents": { # Optional. A map containing the static configurations for each agent in the system. Key: agent_id (matches the `author` field in events). Value: The static configuration of the agent.
+                "a_key": { # Represents configuration for an Agent.
+                  "agentId": "A String", # Required. Unique identifier of the agent. This ID is used to refer to this agent, e.g., in AgentEvent.author, or in the `sub_agents` field. It must be unique within the `agents` map.
+                  "agentType": "A String", # Optional. The type or class of the agent (e.g., "LlmAgent", "RouterAgent", "ToolUseAgent"). Useful for the autorater to understand the expected behavior of the agent.
+                  "description": "A String", # Optional. A high-level description of the agent's role and responsibilities. Critical for evaluating if the agent is routing tasks correctly.
+                  "instruction": "A String", # Optional. Provides instructions for the LLM model, guiding the agent's behavior. Can be static or dynamic. Dynamic instructions can contain placeholders like {variable_name} that will be resolved at runtime using the `AgentEvent.state_delta` field.
+                  "subAgents": [ # Optional. The list of valid agent IDs that this agent can delegate to. This defines the directed edges in the multi-agent system graph topology.
+                    "A String",
+                  ],
+                  "tools": [ # Optional. The list of tools available to this agent.
+                    { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval).
+                      "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation.
+                      },
+                      "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations.
+                        "environment": "A String", # Required. The environment being operated.
+                        "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions.
+                          "A String",
+                        ],
+                      },
+                      "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance.
+                        "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
+                        "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains.
+                          "A String",
+                        ],
+                      },
+                      "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided.
+                        { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client.
+                          "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function.
+                          "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128.
+                          "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1
+                            "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema.
+                            "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`.
+                              # Object with schema name: GoogleCloudAiplatformV1beta1Schema
+                            ],
+                            "default": "", # Optional. Default value to use if the field is not specified.
+                            "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema.
+                              "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
+                            },
+                            "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt.
+                            "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}`
+                              "A String",
+                            ],
+                            "example": "", # Optional. Example of an instance of this schema.
+                            "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type.
+                            "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array.
+                            "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array.
+                            "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string.
+                            "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided.
+                            "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value.
+                            "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array.
+                            "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string.
+                            "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided.
+                            "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value.
+                            "nullable": True or False, # Optional. Indicates if the value of this field can be null.
+                            "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match.
+                            "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object.
+                              "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
+                            },
+                            "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties.
+                              "A String",
+                            ],
+                            "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring
+                            "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present.
+                              "A String",
+                            ],
+                            "title": "A String", # Optional. Title for the schema.
+                            "type": "A String", # Optional. Data type of the schema field.
+                          },
+                          "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`.
+                          "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function.
+                            "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema.
+                            "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`.
+                              # Object with schema name: GoogleCloudAiplatformV1beta1Schema
+                            ],
+                            "default": "", # Optional. Default value to use if the field is not specified.
+                            "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema.
+                              "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
+                            },
+                            "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt.
+                            "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}`
+                              "A String",
+                            ],
+                            "example": "", # Optional. Example of an instance of this schema.
+                            "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type.
+                            "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array.
+                            "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array.
+                            "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string.
+                            "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided.
+                            "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value.
+                            "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array.
+                            "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string.
+                            "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided.
+                            "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value.
+                            "nullable": True or False, # Optional. Indicates if the value of this field can be null.
+                            "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match.
+                            "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object.
+                              "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
+                            },
+                            "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties.
+                              "A String",
+                            ],
+                            "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring
+                            "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present.
+                              "A String",
+                            ],
+                            "title": "A String", # Optional. Title for the schema.
+                            "type": "A String", # Optional. Data type of the schema field.
+                          },
+                          "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`.
+                        },
+                      ],
+                      "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model.
+                        "enableWidget": True or False, # Optional. If true, include the widget context token in the response.
+                      },
+                      "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google.
+                        "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
+                        "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"].
+                          "A String",
+                        ],
+                        "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default.
+                          "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned.
+                          },
+                          "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned.
+                          },
+                        },
+                      },
+                      "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search.
+                        "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source.
+                          "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used.
+                          "mode": "A String", # The mode of the predictor to be used in dynamic retrieval.
+                        },
+                      },
+                      "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation
+                        "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more details.
+                        "customConfigs": { # Optional. Custom configs for ParallelAiSearch. This field can be used to pass any parameter from the Parallel.ai Search API. See the Parallel.ai documentation for the full list of available parameters and their usage: https://docs.parallel.ai/api-reference/search-beta/search Currently only `source_policy`, `excerpts`, `max_results`, `mode`, `fetch_policy` can be set via this field. For example: { "source_policy": { "include_domains": ["google.com", "wikipedia.org"], "exclude_domains": ["example.com"] }, "fetch_policy": { "max_age_seconds": 3600 } }
+                          "a_key": "", # Properties of the object.
+                        },
+                      },
+                      "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation.
+                        "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported.
+                        "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding.
+                          "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead.
+                            "apiKeyConfig": { # The API secret. # The API secret.
+                              "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version}
+                              "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set.
+                            },
+                          },
+                          "apiSpec": "A String", # The API spec that the external API implements.
+                          "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API.
+                            "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth.
+                              "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource.
+                              "apiKeyString": "A String", # Optional. The API key to be used in the request directly.
+                              "httpElementLocation": "A String", # Optional. The location of the API key.
+                              "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name.
+                            },
+                            "authType": "A String", # Type of auth scheme.
+                            "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth.
+                              "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension.
+                            },
+                            "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth.
+                              "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource.
+                            },
+                            "oauthConfig": { # Config for user oauth. # Config for user oauth.
+                              "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time.
+                              "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account.
+                            },
+                            "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth.
+                              "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time.
+                              "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents).
+                            },
+                          },
+                          "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API.
+                            "index": "A String", # The ElasticSearch index to use.
+                            "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param.
+                            "searchTemplate": "A String", # The ElasticSearch search template to use.
+                          },
+                          "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search
+                          "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API.
+                          },
+                        },
+                        "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search.
+                          "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used.
+                            { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec
+                              "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
+                              "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
+                            },
+                          ],
+                          "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
+                          "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`
+                          "filter": "A String", # Optional. Filter strings to be passed to the search API.
+                          "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10.
+                        },
+                        "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService.
+                          "ragCorpora": [ # Optional. Deprecated. Please use rag_resources instead.
+                            "A String",
+                          ],
+                          "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support.
+                            { # The definition of the Rag resource.
+                              "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`
+                              "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field.
+                                "A String",
+                              ],
+                            },
+                          ],
+                          "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query.
+                            "filter": { # Config for filters. # Optional. Config for filters.
+                              "metadataFilter": "A String", # Optional. String for metadata filtering.
+                              "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold.
+                              "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold.
+                            },
+                            "hybridSearch": { # Config for Hybrid Search. # Optional. Config for Hybrid Search.
+                              "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. The range is [0, 1], while 0 means sparse vector search only and 1 means dense vector search only. The default value is 0.5 which balances sparse and dense vector search equally.
+                            },
+                            "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking.
+                              "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker.
+                                "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).
+                              },
+                              "rankService": { # Config for Rank Service. # Optional. Config for Rank Service.
+                                "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest`
+                              },
+                            },
+                            "topK": 42, # Optional. The number of contexts to retrieve.
+                          },
+                          "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora.
+                          "storeContext": True or False, # Optional. Currently only supported for Gemini Multimodal Live API. In Gemini Multimodal Live API, if `store_context` bool is specified, Gemini will leverage it to automatically memorize the interactions between the client and Gemini, and retrieve context when needed to augment the response generation for users' ongoing and future interactions.
+                          "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold.
+                        },
+                      },
+                      "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval.
+                      },
+                    },
+                  ],
+                },
+              },
+              "turns": [ # Optional. A chronological list of conversation turns. Each turn represents a logical execution cycle (e.g., User Input -> Agent Response).
+                { # Represents a single turn/invocation in the conversation.
+                  "events": [ # Optional. The list of events that occurred during this turn.
+                    { # Represents a single event in the execution trace.
+                      "activeTools": [ # Optional. The list of tools that were active/available to the agent at the time of this event. This overrides the `AgentConfig.tools` if set.
+                        { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval).
+                          "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation.
+                          },
+                          "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations.
+                            "environment": "A String", # Required. The environment being operated.
+                            "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions.
+                              "A String",
+                            ],
+                          },
+                          "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance.
+                            "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
+                            "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains.
+                              "A String",
+                            ],
+                          },
+                          "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided.
+                            { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client.
+                              "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function.
+                              "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128.
+                              "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1
+                                "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema.
+                                "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`.
+                                  # Object with schema name: GoogleCloudAiplatformV1beta1Schema
+                                ],
+                                "default": "", # Optional. Default value to use if the field is not specified.
+                                "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema.
+                                  "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
+                                },
+                                "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt.
+                                "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}`
+                                  "A String",
+                                ],
+                                "example": "", # Optional. Example of an instance of this schema.
+                                "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type.
+                                "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array.
+                                "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array.
+                                "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string.
+                                "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided.
+                                "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value.
+                                "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array.
+                                "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string.
+                                "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided.
+                                "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value.
+                                "nullable": True or False, # Optional. Indicates if the value of this field can be null.
+                                "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match.
+                                "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object.
+                                  "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
+                                },
+                                "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties.
+                                  "A String",
+                                ],
+                                "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring
+                                "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present.
+                                  "A String",
+                                ],
+                                "title": "A String", # Optional. Title for the schema.
+                                "type": "A String", # Optional. Data type of the schema field.
+                              },
+                              "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`.
+                              "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function.
+                                "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema.
+                                "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`.
+                                  # Object with schema name: GoogleCloudAiplatformV1beta1Schema
+                                ],
+                                "default": "", # Optional. Default value to use if the field is not specified.
+                                "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema.
+                                  "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
+                                },
+                                "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt.
+                                "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}`
+                                  "A String",
+                                ],
+                                "example": "", # Optional. Example of an instance of this schema.
+                                "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type.
+                                "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array.
+                                "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array.
+                                "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string.
+                                "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided.
+                                "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value.
+                                "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array.
+                                "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string.
+                                "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided.
+                                "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value.
+                                "nullable": True or False, # Optional. Indicates if the value of this field can be null.
+                                "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match.
+                                "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object.
+                                  "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
+                                },
+                                "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties.
+                                  "A String",
+                                ],
+                                "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring
+                                "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present.
+                                  "A String",
+                                ],
+                                "title": "A String", # Optional. Title for the schema.
+                                "type": "A String", # Optional. Data type of the schema field.
+                              },
+                              "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`.
+                            },
+                          ],
+                          "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model.
+                            "enableWidget": True or False, # Optional. If true, include the widget context token in the response.
+                          },
+                          "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google.
+                            "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
+                            "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"].
+                              "A String",
+                            ],
+                            "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default.
+                              "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned.
+                              },
+                              "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned.
+                              },
+                            },
+                          },
+                          "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search.
+                            "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source.
+                              "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used.
+                              "mode": "A String", # The mode of the predictor to be used in dynamic retrieval.
+                            },
+                          },
+                          "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation
+                            "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more details.
+                            "customConfigs": { # Optional. Custom configs for ParallelAiSearch. This field can be used to pass any parameter from the Parallel.ai Search API. See the Parallel.ai documentation for the full list of available parameters and their usage: https://docs.parallel.ai/api-reference/search-beta/search Currently only `source_policy`, `excerpts`, `max_results`, `mode`, `fetch_policy` can be set via this field. For example: { "source_policy": { "include_domains": ["google.com", "wikipedia.org"], "exclude_domains": ["example.com"] }, "fetch_policy": { "max_age_seconds": 3600 } }
+                              "a_key": "", # Properties of the object.
+                            },
+                          },
+                          "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation.
+                            "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported.
+                            "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding.
+                              "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead.
+                                "apiKeyConfig": { # The API secret. # The API secret.
+                                  "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version}
+                                  "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set.
+                                },
+                              },
+                              "apiSpec": "A String", # The API spec that the external API implements.
+                              "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API.
+                                "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth.
+                                  "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource.
+                                  "apiKeyString": "A String", # Optional. The API key to be used in the request directly.
+                                  "httpElementLocation": "A String", # Optional. The location of the API key.
+                                  "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name.
+                                },
+                                "authType": "A String", # Type of auth scheme.
+                                "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth.
+                                  "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension.
+                                },
+                                "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth.
+                                  "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource.
+                                },
+                                "oauthConfig": { # Config for user oauth. # Config for user oauth.
+                                  "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time.
+                                  "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account.
+                                },
+                                "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth.
+                                  "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time.
+                                  "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents).
+                                },
+                              },
+                              "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API.
+                                "index": "A String", # The ElasticSearch index to use.
+                                "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param.
+                                "searchTemplate": "A String", # The ElasticSearch search template to use.
+                              },
+                              "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search
+                              "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API.
+                              },
+                            },
+                            "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search.
+                              "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used.
+                                { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec
+                                  "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
+                                  "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
+                                },
+                              ],
+                              "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
+                              "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`
+                              "filter": "A String", # Optional. Filter strings to be passed to the search API.
+                              "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10.
+                            },
+                            "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService.
+                              "ragCorpora": [ # Optional. Deprecated. Please use rag_resources instead.
+                                "A String",
+                              ],
+                              "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support.
+                                { # The definition of the Rag resource.
+                                  "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`
+                                  "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field.
+                                    "A String",
+                                  ],
+                                },
+                              ],
+                              "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query.
+                                "filter": { # Config for filters. # Optional. Config for filters.
+                                  "metadataFilter": "A String", # Optional. String for metadata filtering.
+                                  "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold.
+                                  "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold.
+                                },
+                                "hybridSearch": { # Config for Hybrid Search. # Optional. Config for Hybrid Search.
+                                  "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. The range is [0, 1], while 0 means sparse vector search only and 1 means dense vector search only. The default value is 0.5 which balances sparse and dense vector search equally.
+                                },
+                                "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking.
+                                  "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker.
+                                    "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).
+                                  },
+                                  "rankService": { # Config for Rank Service. # Optional. Config for Rank Service.
+                                    "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest`
+                                  },
+                                },
+                                "topK": 42, # Optional. The number of contexts to retrieve.
+                              },
+                              "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora.
+                              "storeContext": True or False, # Optional. Currently only supported for Gemini Multimodal Live API. In Gemini Multimodal Live API, if `store_context` bool is specified, Gemini will leverage it to automatically memorize the interactions between the client and Gemini, and retrieve context when needed to augment the response generation for users' ongoing and future interactions.
+                              "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold.
+                            },
+                          },
+                          "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval.
+                          },
+                        },
+                      ],
+                      "author": "A String", # Required. The ID of the agent or entity that generated this event. Use "user" to denote events generated by the end-user.
+                      "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response).
+                        "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part.
+                          { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
+                            "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode.
+                              "outcome": "A String", # Required. Outcome of the code execution.
+                              "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise.
+                            },
+                            "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed.
+                              "code": "A String", # Required. The code to be executed.
+                              "language": "A String", # Required. Programming language of the `code`.
+                            },
+                            "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage.
+                              "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
+                              "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage.
+                              "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                            },
+                            "functionCall": { # A predicted FunctionCall returned from the model that contains a string representing the FunctionDeclaration.name and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function.
+                              "args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details.
+                                "a_key": "", # Properties of the object.
+                              },
+                              "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`.
+                              "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name.
+                              "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally.
+                                { # Partial argument value of the function call.
+                                  "boolValue": True or False, # Optional. Represents a boolean value.
+                                  "jsonPath": "A String", # Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data".
+                                  "nullValue": "A String", # Optional. Represents a null value.
+                                  "numberValue": 3.14, # Optional. Represents a double value.
+                                  "stringValue": "A String", # Optional. Represents a string value.
+                                  "willContinue": True or False, # Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow.
+                                },
+                              ],
+                              "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow.
+                            },
+                            "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted.
+                              "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`.
+                              "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name.
+                              "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types.
+                                { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes.
+                                  "fileData": { # URI based data for function response. # URI based data.
+                                    "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                                    "fileUri": "A String", # Required. URI.
+                                    "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                                  },
+                                  "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes.
+                                    "data": "A String", # Required. Raw bytes.
+                                    "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                                    "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                                  },
+                                },
+                              ],
+                              "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output.
+                                "a_key": "", # Properties of the object.
+                              },
+                              "scheduling": "A String", # Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE.
+                            },
+                            "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request.
+                              "data": "A String", # Required. The raw bytes of the data.
+                              "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
+                              "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                            },
+                            "mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media.
+                              "level": "A String", # The tokenization quality used for given media.
+                            },
+                            "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent.
+                            "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning.
+                            "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests.
+                            "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
+                              "endOffset": "A String", # Optional. The end offset of the video.
+                              "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0].
+                              "startOffset": "A String", # Optional. The start offset of the video.
+                            },
+                          },
+                        ],
+                        "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'.
+                      },
+                      "eventTime": "A String", # Optional. The timestamp when the event occurred.
+                      "stateDelta": { # Optional. The change in the session state caused by this event. This is a key-value map of fields that were modified or added by the event.
+                        "a_key": "", # Properties of the object.
+                      },
+                    },
+                  ],
+                  "turnId": "A String", # Optional. A unique identifier for the turn. Useful for referencing specific turns across systems.
+                  "turnIndex": 42, # Required. The 0-based index of the turn in the conversation sequence.
+                },
+              ],
+            },
+            "candidate": "A String", # Required. The name of the candidate that produced the response.
+            "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). # Output only. Error while scraping model or agent.
+              "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.
+            },
+            "events": [ # Optional. Intermediate events (such as tool calls and responses) that led to the final response.
+              { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message.
+                "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part.
+                  { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
+                    "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode.
+                      "outcome": "A String", # Required. Outcome of the code execution.
+                      "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise.
+                    },
+                    "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed.
+                      "code": "A String", # Required. The code to be executed.
+                      "language": "A String", # Required. Programming language of the `code`.
+                    },
+                    "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage.
+                      "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
+                      "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage.
+                      "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                    },
+                    "functionCall": { # A predicted FunctionCall returned from the model that contains a string representing the FunctionDeclaration.name and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function.
+                      "args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details.
+                        "a_key": "", # Properties of the object.
+                      },
+                      "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`.
+                      "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name.
+                      "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally.
+                        { # Partial argument value of the function call.
+                          "boolValue": True or False, # Optional. Represents a boolean value.
+                          "jsonPath": "A String", # Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data".
+                          "nullValue": "A String", # Optional. Represents a null value.
+                          "numberValue": 3.14, # Optional. Represents a double value.
+                          "stringValue": "A String", # Optional. Represents a string value.
+                          "willContinue": True or False, # Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow.
+                        },
+                      ],
+                      "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow.
+                    },
+                    "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted.
+                      "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`.
+                      "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name.
+                      "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types.
+                        { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes.
+                          "fileData": { # URI based data for function response. # URI based data.
+                            "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                            "fileUri": "A String", # Required. URI.
+                            "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                          },
+                          "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes.
+                            "data": "A String", # Required. Raw bytes.
+                            "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                            "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                          },
+                        },
+                      ],
+                      "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output.
+                        "a_key": "", # Properties of the object.
+                      },
+                      "scheduling": "A String", # Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE.
+                    },
+                    "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request.
+                      "data": "A String", # Required. The raw bytes of the data.
+                      "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
+                      "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                    },
+                    "mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media.
+                      "level": "A String", # The tokenization quality used for given media.
+                    },
+                    "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent.
+                    "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning.
+                    "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests.
+                    "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
+                      "endOffset": "A String", # Optional. The end offset of the video.
+                      "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0].
+                      "startOffset": "A String", # Optional. The start offset of the video.
+                    },
+                  },
+                ],
+                "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'.
+              },
+            ],
+            "text": "A String", # Text response.
+            "value": "", # Fields and values that can be used to populate the response template.
+          },
+          "prompt": { # Prompt to be evaluated. This can represent a single-turn prompt or a multi-turn conversation for agent evaluations. # Optional. The request/prompt to evaluate.
+            "agentData": { # Represents data specific to multi-turn agent evaluations. # Optional. Represents the complete execution trace of a multi-turn conversation, which can involve single or multiple agents. This serves as the input context for agent scraping.
+              "agents": { # Optional. A map containing the static configurations for each agent in the system. Key: agent_id (matches the `author` field in events). Value: The static configuration of the agent.
+                "a_key": { # Represents configuration for an Agent.
+                  "agentId": "A String", # Required. Unique identifier of the agent. This ID is used to refer to this agent, e.g., in AgentEvent.author, or in the `sub_agents` field. It must be unique within the `agents` map.
+                  "agentType": "A String", # Optional. The type or class of the agent (e.g., "LlmAgent", "RouterAgent", "ToolUseAgent"). Useful for the autorater to understand the expected behavior of the agent.
+                  "description": "A String", # Optional. A high-level description of the agent's role and responsibilities. Critical for evaluating if the agent is routing tasks correctly.
+                  "instruction": "A String", # Optional. Provides instructions for the LLM model, guiding the agent's behavior. Can be static or dynamic. Dynamic instructions can contain placeholders like {variable_name} that will be resolved at runtime using the `AgentEvent.state_delta` field.
+                  "subAgents": [ # Optional. The list of valid agent IDs that this agent can delegate to. This defines the directed edges in the multi-agent system graph topology.
+                    "A String",
+                  ],
+                  "tools": [ # Optional. The list of tools available to this agent.
+                    { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval).
+                      "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation.
+                      },
+                      "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations.
+                        "environment": "A String", # Required. The environment being operated.
+                        "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions.
+                          "A String",
+                        ],
+                      },
+                      "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance.
+                        "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
+                        "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains.
+                          "A String",
+                        ],
+                      },
+                      "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided.
+                        { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client.
+                          "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function.
+                          "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128.
+                          "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1
+                            "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema.
+                            "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`.
+                              # Object with schema name: GoogleCloudAiplatformV1beta1Schema
+                            ],
+                            "default": "", # Optional. Default value to use if the field is not specified.
+                            "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema.
+                              "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
+                            },
+                            "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt.
+                            "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}`
+                              "A String",
+                            ],
+                            "example": "", # Optional. Example of an instance of this schema.
+                            "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type.
+                            "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array.
+                            "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array.
+                            "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string.
+                            "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided.
+                            "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value.
+                            "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array.
+                            "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string.
+                            "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided.
+                            "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value.
+                            "nullable": True or False, # Optional. Indicates if the value of this field can be null.
+                            "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match.
+                            "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object.
+                              "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
+                            },
+                            "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties.
+                              "A String",
+                            ],
+                            "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring
+                            "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present.
+                              "A String",
+                            ],
+                            "title": "A String", # Optional. Title for the schema.
+                            "type": "A String", # Optional. Data type of the schema field.
+                          },
+                          "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`.
+                          "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function.
+                            "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema.
+                            "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`.
+                              # Object with schema name: GoogleCloudAiplatformV1beta1Schema
+                            ],
+                            "default": "", # Optional. Default value to use if the field is not specified.
+                            "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema.
+                              "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
+                            },
+                            "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt.
+                            "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}`
+                              "A String",
+                            ],
+                            "example": "", # Optional. Example of an instance of this schema.
+                            "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type.
+                            "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array.
+                            "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array.
+                            "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string.
+                            "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided.
+                            "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value.
+                            "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array.
+                            "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string.
+                            "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided.
+                            "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value.
+                            "nullable": True or False, # Optional. Indicates if the value of this field can be null.
+                            "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match.
+                            "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object.
+                              "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
+                            },
+                            "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties.
+                              "A String",
+                            ],
+                            "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring
+                            "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present.
+                              "A String",
+                            ],
+                            "title": "A String", # Optional. Title for the schema.
+                            "type": "A String", # Optional. Data type of the schema field.
+                          },
+                          "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`.
+                        },
+                      ],
+                      "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model.
+                        "enableWidget": True or False, # Optional. If true, include the widget context token in the response.
+                      },
+                      "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google.
+                        "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
+                        "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"].
+                          "A String",
+                        ],
+                        "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default.
+                          "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned.
+                          },
+                          "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned.
+                          },
+                        },
+                      },
+                      "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search.
+                        "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source.
+                          "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used.
+                          "mode": "A String", # The mode of the predictor to be used in dynamic retrieval.
+                        },
+                      },
+                      "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation
+                        "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more details.
+                        "customConfigs": { # Optional. Custom configs for ParallelAiSearch. This field can be used to pass any parameter from the Parallel.ai Search API. See the Parallel.ai documentation for the full list of available parameters and their usage: https://docs.parallel.ai/api-reference/search-beta/search Currently only `source_policy`, `excerpts`, `max_results`, `mode`, `fetch_policy` can be set via this field. For example: { "source_policy": { "include_domains": ["google.com", "wikipedia.org"], "exclude_domains": ["example.com"] }, "fetch_policy": { "max_age_seconds": 3600 } }
+                          "a_key": "", # Properties of the object.
+                        },
+                      },
+                      "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation.
+                        "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported.
+                        "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding.
+                          "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead.
+                            "apiKeyConfig": { # The API secret. # The API secret.
+                              "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version}
+                              "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set.
+                            },
+                          },
+                          "apiSpec": "A String", # The API spec that the external API implements.
+                          "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API.
+                            "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth.
+                              "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource.
+                              "apiKeyString": "A String", # Optional. The API key to be used in the request directly.
+                              "httpElementLocation": "A String", # Optional. The location of the API key.
+                              "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name.
+                            },
+                            "authType": "A String", # Type of auth scheme.
+                            "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth.
+                              "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension.
+                            },
+                            "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth.
+                              "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource.
+                            },
+                            "oauthConfig": { # Config for user oauth. # Config for user oauth.
+                              "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time.
+                              "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account.
+                            },
+                            "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth.
+                              "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time.
+                              "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents).
+                            },
+                          },
+                          "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API.
+                            "index": "A String", # The ElasticSearch index to use.
+                            "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param.
+                            "searchTemplate": "A String", # The ElasticSearch search template to use.
+                          },
+                          "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search
+                          "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API.
+                          },
+                        },
+                        "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search.
+                          "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used.
+                            { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec
+                              "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
+                              "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
+                            },
+                          ],
+                          "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
+                          "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`
+                          "filter": "A String", # Optional. Filter strings to be passed to the search API.
+                          "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10.
+                        },
+                        "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService.
+                          "ragCorpora": [ # Optional. Deprecated. Please use rag_resources instead.
+                            "A String",
+                          ],
+                          "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support.
+                            { # The definition of the Rag resource.
+                              "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`
+                              "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field.
+                                "A String",
+                              ],
+                            },
+                          ],
+                          "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query.
+                            "filter": { # Config for filters. # Optional. Config for filters.
+                              "metadataFilter": "A String", # Optional. String for metadata filtering.
+                              "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold.
+                              "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold.
+                            },
+                            "hybridSearch": { # Config for Hybrid Search. # Optional. Config for Hybrid Search.
+                              "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. The range is [0, 1], while 0 means sparse vector search only and 1 means dense vector search only. The default value is 0.5 which balances sparse and dense vector search equally.
+                            },
+                            "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking.
+                              "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker.
+                                "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).
+                              },
+                              "rankService": { # Config for Rank Service. # Optional. Config for Rank Service.
+                                "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest`
+                              },
+                            },
+                            "topK": 42, # Optional. The number of contexts to retrieve.
+                          },
+                          "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora.
+                          "storeContext": True or False, # Optional. Currently only supported for Gemini Multimodal Live API. In Gemini Multimodal Live API, if `store_context` bool is specified, Gemini will leverage it to automatically memorize the interactions between the client and Gemini, and retrieve context when needed to augment the response generation for users' ongoing and future interactions.
+                          "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold.
+                        },
+                      },
+                      "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval.
+                      },
+                    },
+                  ],
+                },
+              },
+              "turns": [ # Optional. A chronological list of conversation turns. Each turn represents a logical execution cycle (e.g., User Input -> Agent Response).
+                { # Represents a single turn/invocation in the conversation.
+                  "events": [ # Optional. The list of events that occurred during this turn.
+                    { # Represents a single event in the execution trace.
+                      "activeTools": [ # Optional. The list of tools that were active/available to the agent at the time of this event. This overrides the `AgentConfig.tools` if set.
+                        { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval).
+                          "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation.
+                          },
+                          "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations.
+                            "environment": "A String", # Required. The environment being operated.
+                            "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions.
+                              "A String",
+                            ],
+                          },
+                          "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance.
+                            "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
+                            "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains.
+                              "A String",
+                            ],
+                          },
+                          "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided.
+                            { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client.
+                              "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function.
+                              "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128.
+                              "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1
+                                "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema.
+                                "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`.
+                                  # Object with schema name: GoogleCloudAiplatformV1beta1Schema
+                                ],
+                                "default": "", # Optional. Default value to use if the field is not specified.
+                                "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema.
+                                  "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
+                                },
+                                "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt.
+                                "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}`
+                                  "A String",
+                                ],
+                                "example": "", # Optional. Example of an instance of this schema.
+                                "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type.
+                                "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array.
+                                "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array.
+                                "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string.
+                                "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided.
+                                "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value.
+                                "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array.
+                                "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string.
+                                "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided.
+                                "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value.
+                                "nullable": True or False, # Optional. Indicates if the value of this field can be null.
+                                "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match.
+                                "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object.
+                                  "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
+                                },
+                                "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties.
+                                  "A String",
+                                ],
+                                "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring
+                                "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present.
+                                  "A String",
+                                ],
+                                "title": "A String", # Optional. Title for the schema.
+                                "type": "A String", # Optional. Data type of the schema field.
+                              },
+                              "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`.
+                              "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function.
+                                "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema.
+                                "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`.
+                                  # Object with schema name: GoogleCloudAiplatformV1beta1Schema
+                                ],
+                                "default": "", # Optional. Default value to use if the field is not specified.
+                                "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema.
+                                  "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
+                                },
+                                "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt.
+                                "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}`
+                                  "A String",
+                                ],
+                                "example": "", # Optional. Example of an instance of this schema.
+                                "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type.
+                                "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array.
+                                "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array.
+                                "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string.
+                                "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided.
+                                "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value.
+                                "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array.
+                                "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string.
+                                "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided.
+                                "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value.
+                                "nullable": True or False, # Optional. Indicates if the value of this field can be null.
+                                "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match.
+                                "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object.
+                                  "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
+                                },
+                                "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties.
+                                  "A String",
+                                ],
+                                "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring
+                                "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present.
+                                  "A String",
+                                ],
+                                "title": "A String", # Optional. Title for the schema.
+                                "type": "A String", # Optional. Data type of the schema field.
+                              },
+                              "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`.
+                            },
+                          ],
+                          "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model.
+                            "enableWidget": True or False, # Optional. If true, include the widget context token in the response.
+                          },
+                          "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google.
+                            "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
+                            "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"].
+                              "A String",
+                            ],
+                            "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default.
+                              "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned.
+                              },
+                              "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned.
+                              },
+                            },
+                          },
+                          "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search.
+                            "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source.
+                              "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used.
+                              "mode": "A String", # The mode of the predictor to be used in dynamic retrieval.
+                            },
+                          },
+                          "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation
+                            "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more details.
+                            "customConfigs": { # Optional. Custom configs for ParallelAiSearch. This field can be used to pass any parameter from the Parallel.ai Search API. See the Parallel.ai documentation for the full list of available parameters and their usage: https://docs.parallel.ai/api-reference/search-beta/search Currently only `source_policy`, `excerpts`, `max_results`, `mode`, `fetch_policy` can be set via this field. For example: { "source_policy": { "include_domains": ["google.com", "wikipedia.org"], "exclude_domains": ["example.com"] }, "fetch_policy": { "max_age_seconds": 3600 } }
+                              "a_key": "", # Properties of the object.
+                            },
+                          },
+                          "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation.
+                            "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported.
+                            "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding.
+                              "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead.
+                                "apiKeyConfig": { # The API secret. # The API secret.
+                                  "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version}
+                                  "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set.
+                                },
+                              },
+                              "apiSpec": "A String", # The API spec that the external API implements.
+                              "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API.
+                                "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth.
+                                  "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource.
+                                  "apiKeyString": "A String", # Optional. The API key to be used in the request directly.
+                                  "httpElementLocation": "A String", # Optional. The location of the API key.
+                                  "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name.
+                                },
+                                "authType": "A String", # Type of auth scheme.
+                                "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth.
+                                  "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension.
+                                },
+                                "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth.
+                                  "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource.
+                                },
+                                "oauthConfig": { # Config for user oauth. # Config for user oauth.
+                                  "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time.
+                                  "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account.
+                                },
+                                "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth.
+                                  "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time.
+                                  "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents).
+                                },
+                              },
+                              "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API.
+                                "index": "A String", # The ElasticSearch index to use.
+                                "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param.
+                                "searchTemplate": "A String", # The ElasticSearch search template to use.
+                              },
+                              "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search
+                              "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API.
+                              },
+                            },
+                            "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search.
+                              "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used.
+                                { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec
+                                  "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
+                                  "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
+                                },
+                              ],
+                              "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
+                              "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`
+                              "filter": "A String", # Optional. Filter strings to be passed to the search API.
+                              "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10.
+                            },
+                            "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService.
+                              "ragCorpora": [ # Optional. Deprecated. Please use rag_resources instead.
+                                "A String",
+                              ],
+                              "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support.
+                                { # The definition of the Rag resource.
+                                  "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`
+                                  "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field.
+                                    "A String",
+                                  ],
+                                },
+                              ],
+                              "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query.
+                                "filter": { # Config for filters. # Optional. Config for filters.
+                                  "metadataFilter": "A String", # Optional. String for metadata filtering.
+                                  "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold.
+                                  "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold.
+                                },
+                                "hybridSearch": { # Config for Hybrid Search. # Optional. Config for Hybrid Search.
+                                  "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. The range is [0, 1], while 0 means sparse vector search only and 1 means dense vector search only. The default value is 0.5 which balances sparse and dense vector search equally.
+                                },
+                                "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking.
+                                  "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker.
+                                    "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).
+                                  },
+                                  "rankService": { # Config for Rank Service. # Optional. Config for Rank Service.
+                                    "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest`
+                                  },
+                                },
+                                "topK": 42, # Optional. The number of contexts to retrieve.
+                              },
+                              "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora.
+                              "storeContext": True or False, # Optional. Currently only supported for Gemini Multimodal Live API. In Gemini Multimodal Live API, if `store_context` bool is specified, Gemini will leverage it to automatically memorize the interactions between the client and Gemini, and retrieve context when needed to augment the response generation for users' ongoing and future interactions.
+                              "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold.
+                            },
+                          },
+                          "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval.
+                          },
+                        },
+                      ],
+                      "author": "A String", # Required. The ID of the agent or entity that generated this event. Use "user" to denote events generated by the end-user.
+                      "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response).
+                        "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part.
+                          { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
+                            "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode.
+                              "outcome": "A String", # Required. Outcome of the code execution.
+                              "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise.
+                            },
+                            "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed.
+                              "code": "A String", # Required. The code to be executed.
+                              "language": "A String", # Required. Programming language of the `code`.
+                            },
+                            "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage.
+                              "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
+                              "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage.
+                              "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                            },
+                            "functionCall": { # A predicted FunctionCall returned from the model that contains a string representing the FunctionDeclaration.name and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function.
+                              "args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details.
+                                "a_key": "", # Properties of the object.
+                              },
+                              "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`.
+                              "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name.
+                              "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally.
+                                { # Partial argument value of the function call.
+                                  "boolValue": True or False, # Optional. Represents a boolean value.
+                                  "jsonPath": "A String", # Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data".
+                                  "nullValue": "A String", # Optional. Represents a null value.
+                                  "numberValue": 3.14, # Optional. Represents a double value.
+                                  "stringValue": "A String", # Optional. Represents a string value.
+                                  "willContinue": True or False, # Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow.
+                                },
+                              ],
+                              "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow.
+                            },
+                            "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted.
+                              "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`.
+                              "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name.
+                              "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types.
+                                { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes.
+                                  "fileData": { # URI based data for function response. # URI based data.
+                                    "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                                    "fileUri": "A String", # Required. URI.
+                                    "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                                  },
+                                  "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes.
+                                    "data": "A String", # Required. Raw bytes.
+                                    "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                                    "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                                  },
+                                },
+                              ],
+                              "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output.
+                                "a_key": "", # Properties of the object.
+                              },
+                              "scheduling": "A String", # Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE.
+                            },
+                            "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request.
+                              "data": "A String", # Required. The raw bytes of the data.
+                              "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
+                              "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                            },
+                            "mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media.
+                              "level": "A String", # The tokenization quality used for given media.
+                            },
+                            "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent.
+                            "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning.
+                            "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests.
+                            "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
+                              "endOffset": "A String", # Optional. The end offset of the video.
+                              "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0].
+                              "startOffset": "A String", # Optional. The start offset of the video.
+                            },
+                          },
+                        ],
+                        "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'.
+                      },
+                      "eventTime": "A String", # Optional. The timestamp when the event occurred.
+                      "stateDelta": { # Optional. The change in the session state caused by this event. This is a key-value map of fields that were modified or added by the event.
+                        "a_key": "", # Properties of the object.
+                      },
+                    },
+                  ],
+                  "turnId": "A String", # Optional. A unique identifier for the turn. Useful for referencing specific turns across systems.
+                  "turnIndex": 42, # Required. The 0-based index of the turn in the conversation sequence.
+                },
+              ],
+            },
+            "promptTemplateData": { # Message to hold a prompt template and the values to populate the template. # Prompt template data.
+              "values": { # The values for fields in the prompt template.
+                "a_key": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message.
+                  "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part.
+                    { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
+                      "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode.
+                        "outcome": "A String", # Required. Outcome of the code execution.
+                        "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise.
+                      },
+                      "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed.
+                        "code": "A String", # Required. The code to be executed.
+                        "language": "A String", # Required. Programming language of the `code`.
+                      },
+                      "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage.
+                        "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
+                        "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage.
+                        "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                      },
+                      "functionCall": { # A predicted FunctionCall returned from the model that contains a string representing the FunctionDeclaration.name and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function.
+                        "args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details.
+                          "a_key": "", # Properties of the object.
+                        },
+                        "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`.
+                        "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name.
+                        "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally.
+                          { # Partial argument value of the function call.
+                            "boolValue": True or False, # Optional. Represents a boolean value.
+                            "jsonPath": "A String", # Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data".
+                            "nullValue": "A String", # Optional. Represents a null value.
+                            "numberValue": 3.14, # Optional. Represents a double value.
+                            "stringValue": "A String", # Optional. Represents a string value.
+                            "willContinue": True or False, # Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow.
+                          },
+                        ],
+                        "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow.
+                      },
+                      "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted.
+                        "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`.
+                        "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name.
+                        "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types.
+                          { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes.
+                            "fileData": { # URI based data for function response. # URI based data.
+                              "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                              "fileUri": "A String", # Required. URI.
+                              "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                            },
+                            "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes.
+                              "data": "A String", # Required. Raw bytes.
+                              "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                              "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                            },
+                          },
+                        ],
+                        "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output.
+                          "a_key": "", # Properties of the object.
+                        },
+                        "scheduling": "A String", # Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE.
+                      },
+                      "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request.
+                        "data": "A String", # Required. The raw bytes of the data.
+                        "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
+                        "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                      },
+                      "mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media.
+                        "level": "A String", # The tokenization quality used for given media.
+                      },
+                      "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent.
+                      "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning.
+                      "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests.
+                      "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
+                        "endOffset": "A String", # Optional. The end offset of the video.
+                        "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0].
+                        "startOffset": "A String", # Optional. The start offset of the video.
+                      },
+                    },
+                  ],
+                  "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'.
+                },
+              },
+            },
+            "text": "A String", # Text prompt.
+            "userScenario": { # User scenario to help simulate multi-turn agent running results. # Optional. The generated user scenario used to drive multi-turn agent running results.
+              "conversationPlan": "A String", # Required. The plan for the conversation, used to drive the multi-turn agent run and generate the simulated agent evaluation dataset.
+              "startingPrompt": "A String", # Required. The prompt that starts the conversation between the simulated user and the agent under test.
+            },
+            "value": "", # Fields and values that can be used to populate the prompt template.
+          },
+          "rubrics": { # Optional. Named groups of rubrics associated with this prompt. The key is a user-defined name for the rubric group.
+            "a_key": { # A group of rubrics, used for grouping rubrics based on a metric or a version.
+              "displayName": "A String", # Human-readable name for the group. This should be unique within a given context if used for display or selection. Example: "Instruction Following V1", "Content Quality - Summarization Task".
+              "groupId": "A String", # Unique identifier for the group.
+              "rubrics": [ # Rubrics that are part of this group.
+                { # Message representing a single testable criterion for evaluation. One input prompt could have multiple rubrics.
+                  "content": { # Content of the rubric, defining the testable criteria. # Required. The actual testable criteria for the rubric.
+                    "property": { # Defines criteria based on a specific property. # Evaluation criteria based on a specific property.
+                      "description": "A String", # Description of the property being evaluated. Example: "The model's response is grammatically correct."
+                    },
+                  },
+                  "importance": "A String", # Optional. The relative importance of this rubric.
+                  "rubricId": "A String", # Unique identifier for the rubric. This ID is used to refer to this rubric, e.g., in RubricVerdict.
+                  "type": "A String", # Optional. A type designator for the rubric, which can inform how it's evaluated or interpreted by systems or users. It's recommended to use consistent, well-defined, upper snake_case strings. Examples: "SUMMARIZATION_QUALITY", "SAFETY_HARMFUL_CONTENT", "INSTRUCTION_ADHERENCE".
+                },
+              ],
+            },
+          },
+        },
+      },
+    ],
+  },
+}
+
+  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, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+
generateSyntheticData(location, body=None, x__xgafv=None)
Generates synthetic (artificial) data based on a description
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.onlineEvaluators.html b/docs/dyn/aiplatform_v1beta1.projects.locations.onlineEvaluators.html
new file mode 100644
index 0000000000..75dd7ea1d9
--- /dev/null
+++ b/docs/dyn/aiplatform_v1beta1.projects.locations.onlineEvaluators.html
@@ -0,0 +1,1805 @@
+
+
+
+

Vertex AI API . projects . locations . onlineEvaluators

+

Instance Methods

+

+ activate(name, body=None, x__xgafv=None)

+

Activates an OnlineEvaluator.

+

+ close()

+

Close httplib2 connections.

+

+ create(parent, body=None, x__xgafv=None)

+

Creates an OnlineEvaluator in the given project and location.

+

+ delete(name, x__xgafv=None)

+

Deletes an OnlineEvaluator.

+

+ get(name, x__xgafv=None)

+

Gets details of an OnlineEvaluator.

+

+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists the OnlineEvaluators for the given project and location.

+

+ list_next()

+

Retrieves the next page of results.

+

+ patch(name, body=None, updateMask=None, x__xgafv=None)

+

Updates the fields of an OnlineEvaluator.

+

+ suspend(name, body=None, x__xgafv=None)

+

Suspends an OnlineEvaluator. When an OnlineEvaluator is suspended, it won't run any evaluations until it is activated again.

+

Method Details

+
+ activate(name, body=None, x__xgafv=None) +
Activates an OnlineEvaluator.
+
+Args:
+  name: string, Required. The name of the OnlineEvaluator to activate. Format: projects/{project}/locations/{location}/onlineEvaluators/{id}. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for ActivateOnlineEvaluator.
+}
+
+  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, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, x__xgafv=None) +
Creates an OnlineEvaluator in the given project and location.
+
+Args:
+  parent: string, Required. The parent resource where the OnlineEvaluator will be created. Format: projects/{project}/locations/{location}. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # An OnlineEvaluator contains the configuration for an Online Evaluation.
+  "agentResource": "A String", # Required. Immutable. The name of the agent that the OnlineEvaluator evaluates periodically. This value is used to filter the traces with a matching cloud.resource_id and link the evaluation results with relevant dashboards/UIs. This field is immutable. Once set, it cannot be changed.
+  "cloudObservability": { # Data source for the OnlineEvaluator, based on GCP Observability stack (Cloud Trace & Cloud Logging). # Data source for the OnlineEvaluator, based on GCP Observability stack (Cloud Trace & Cloud Logging).
+    "logView": "A String", # Optional. Optional log view that will be used to query logs. If empty, the `_Default` view will be used.
+    "openTelemetry": { # Configuration for data source following OpenTelemetry. # Data source follows OpenTelemetry convention.
+      "semconvVersion": "A String", # Required. Defines which version OTel Semantic Convention the data follows. Can be "1.39.0" or newer.
+    },
+    "traceScope": { # Defines the scope and filters for selecting traces. # Scope online evaluation to single traces.
+      "filter": [ # Optional. A list of predicates to filter traces. Multiple predicates are combined using AND.
+        { # Defines a single filter predicate.
+          "duration": { # Defines a predicate for filtering based on a numeric value. # Filter on the duration of a trace.
+            "comparisonOperator": "A String", # Required. The comparison operator to apply.
+            "value": 3.14, # Required. The value to compare against.
+          },
+          "totalTokenUsage": { # Defines a predicate for filtering based on a numeric value. # Filter on the total token usage within a trace.
+            "comparisonOperator": "A String", # Required. The comparison operator to apply.
+            "value": 3.14, # Required. The value to compare against.
+          },
+        },
+      ],
+    },
+    "traceView": "A String", # Optional. Optional trace view that will be used to query traces. If empty, the `_Default` view will be used.
+  },
+  "config": { # Configuration for sampling behavior of the OnlineEvaluator. The OnlineEvaluator runs at a fixed interval of 10 minutes. # Required. Configuration for the OnlineEvaluator.
+    "maxEvaluatedSamplesPerRun": "A String", # Optional. The maximum number of evaluations to perform per run. If set to 0, the number is unbounded.
+    "randomSampling": { # Configuration for random sampling. # Random sampling method.
+      "percentage": 42, # Required. The percentage of traces to sample for evaluation. Must be an integer between 0 and 100.
+    },
+  },
+  "createTime": "A String", # Output only. Timestamp when the OnlineEvaluator was created.
+  "displayName": "A String", # Optional. Human-readable name for the `OnlineEvaluator`. The name doesn't have to be unique. The name can consist of any UTF-8 characters. The maximum length is `63` characters. If the display name exceeds max characters, an `INVALID_ARGUMENT` error is returned.
+  "metricSources": [ # Required. A list of metric sources to be used for evaluating samples. At least one MetricSource must be provided.
+    { # The metric source used for evaluation.
+      "metric": { # The metric used for running evaluations. # Inline metric config.
+        "aggregationMetrics": [ # Optional. The aggregation metrics to use.
+          "A String",
+        ],
+        "bleuSpec": { # Spec for bleu score metric - calculates the precision of n-grams in the prediction as compared to reference - returns a score ranging between 0 to 1. # Spec for bleu metric.
+          "useEffectiveOrder": True or False, # Optional. Whether to use_effective_order to compute bleu score.
+        },
+        "computationBasedMetricSpec": { # Specification for a computation based metric. # Spec for a computation based metric.
+          "parameters": { # Optional. A map of parameters for the metric, e.g. {"rouge_type": "rougeL"}.
+            "a_key": "", # Properties of the object.
+          },
+          "type": "A String", # Required. The type of the computation based metric.
+        },
+        "customCodeExecutionSpec": { # Specificies a metric that is populated by evaluating user-defined Python code. # Spec for Custom Code Execution metric.
+          "evaluationFunction": "A String", # Required. Python function. Expected user to define the following function, e.g.: def evaluate(instance: dict[str, Any]) -> float: Please include this function signature in the code snippet. Instance is the evaluation instance, any fields populated in the instance are available to the function as instance[field_name]. Example: Example input: ``` instance= EvaluationInstance( response=EvaluationInstance.InstanceData(text="The answer is 4."), reference=EvaluationInstance.InstanceData(text="4") ) ``` Example converted input: ``` { 'response': {'text': 'The answer is 4.'}, 'reference': {'text': '4'} } ``` Example python function: ``` def evaluate(instance: dict[str, Any]) -> float: if instance'response' == instance'reference': return 1.0 return 0.0 ``` CustomCodeExecutionSpec is also supported in Batch Evaluation (EvalDataset RPC) and Tuning Evaluation. Each line in the input jsonl file will be converted to dict[str, Any] and passed to the evaluation function.
+        },
+        "exactMatchSpec": { # Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0. # Spec for exact match metric.
+        },
+        "llmBasedMetricSpec": { # Specification for an LLM based metric. # Spec for an LLM based metric.
+          "additionalConfig": { # Optional. Optional additional configuration for the metric.
+            "a_key": "", # Properties of the object.
+          },
+          "judgeAutoraterConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Optional. Optional configuration for the judge LLM (Autorater).
+            "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
+            "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias.
+            "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs.
+              "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response.
+              "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one.
+              "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response.
+              "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0].
+              "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features.
+                "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+                "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images.
+                  "compressionQuality": 42, # Optional. The compression quality of the output image.
+                  "mimeType": "A String", # Optional. The image format that the output should be saved as.
+                },
+                "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`.
+                "personGeneration": "A String", # Optional. Controls whether the model can generate people.
+                "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people.
+              },
+              "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response.
+              "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses.
+              "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model.
+              "modelConfig": { # Config for model selection. # Optional. Config for model selection.
+                "featureSelectionPreference": "A String", # Required. Feature selection preference.
+              },
+              "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0].
+              "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`.
+              "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging.
+              "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined.
+              "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image.
+                "A String",
+              ],
+              "responseSchema": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`.
+                "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema.
+                "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`.
+                  # Object with schema name: GoogleCloudAiplatformV1beta1Schema
+                ],
+                "default": "", # Optional. Default value to use if the field is not specified.
+                "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema.
+                  "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
+                },
+                "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt.
+                "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}`
+                  "A String",
+                ],
+                "example": "", # Optional. Example of an instance of this schema.
+                "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type.
+                "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array.
+                "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array.
+                "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string.
+                "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided.
+                "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value.
+                "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array.
+                "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string.
+                "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided.
+                "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value.
+                "nullable": True or False, # Optional. Indicates if the value of this field can be null.
+                "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match.
+                "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object.
+                  "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
+                },
+                "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties.
+                  "A String",
+                ],
+                "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring
+                "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present.
+                  "A String",
+                ],
+                "title": "A String", # Optional. Title for the schema.
+                "type": "A String", # Optional. Data type of the schema field.
+              },
+              "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration.
+                "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request.
+                  "modelRoutingPreference": "A String", # The model routing preference.
+                },
+                "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually.
+                  "modelName": "A String", # The name of the model to use. Only public LLM models are accepted.
+                },
+              },
+              "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results.
+              "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config.
+                "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis.
+                "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+                  "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+                    { # Configuration for a single speaker in a multi-speaker setup.
+                      "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+                      "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker.
+                        "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice.
+                          "voiceName": "A String", # The name of the prebuilt voice to use.
+                        },
+                        "replicatedVoiceConfig": { # The configuration for the replicated voice to use. # Optional. The configuration for a replicated voice. This enables users to replicate a voice from an audio sample.
+                          "mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set.
+                          "voiceSampleAudio": "A String", # Optional. The sample of the custom voice.
+                        },
+                      },
+                    },
+                  ],
+                },
+                "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use.
+                  "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice.
+                    "voiceName": "A String", # The name of the prebuilt voice to use.
+                  },
+                  "replicatedVoiceConfig": { # The configuration for the replicated voice to use. # Optional. The configuration for a replicated voice. This enables users to replicate a voice from an audio sample.
+                    "mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set.
+                    "voiceSampleAudio": "A String", # Optional. The sample of the custom voice.
+                  },
+                },
+              },
+              "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker.
+                "A String",
+              ],
+              "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0].
+              "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking.
+                "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available.
+                "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency.
+                "thinkingLevel": "A String", # Optional. The number of thoughts tokens that the model should generate.
+              },
+              "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words.
+              "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both.
+            },
+            "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32.
+          },
+          "metricPromptTemplate": "A String", # Required. Template for the prompt sent to the judge model.
+          "predefinedRubricGenerationSpec": { # The spec for a pre-defined metric. # Dynamically generate rubrics using a predefined spec.
+            "metricSpecName": "A String", # Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1".
+            "metricSpecParameters": { # Optional. The parameters needed to run the pre-defined metric.
+              "a_key": "", # Properties of the object.
+            },
+          },
+          "rubricGenerationSpec": { # Specification for how rubrics should be generated. # Dynamically generate rubrics using this specification.
+            "modelConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation.
+              "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
+              "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias.
+              "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs.
+                "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response.
+                "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one.
+                "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response.
+                "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0].
+                "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features.
+                  "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+                  "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images.
+                    "compressionQuality": 42, # Optional. The compression quality of the output image.
+                    "mimeType": "A String", # Optional. The image format that the output should be saved as.
+                  },
+                  "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`.
+                  "personGeneration": "A String", # Optional. Controls whether the model can generate people.
+                  "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people.
+                },
+                "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response.
+                "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses.
+                "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model.
+                "modelConfig": { # Config for model selection. # Optional. Config for model selection.
+                  "featureSelectionPreference": "A String", # Required. Feature selection preference.
+                },
+                "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0].
+                "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`.
+                "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging.
+                "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined.
+                "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image.
+                  "A String",
+                ],
+                "responseSchema": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`.
+                  "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema.
+                  "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`.
+                    # Object with schema name: GoogleCloudAiplatformV1beta1Schema
+                  ],
+                  "default": "", # Optional. Default value to use if the field is not specified.
+                  "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema.
+                    "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
+                  },
+                  "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt.
+                  "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}`
+                    "A String",
+                  ],
+                  "example": "", # Optional. Example of an instance of this schema.
+                  "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type.
+                  "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array.
+                  "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array.
+                  "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string.
+                  "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided.
+                  "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value.
+                  "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array.
+                  "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string.
+                  "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided.
+                  "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value.
+                  "nullable": True or False, # Optional. Indicates if the value of this field can be null.
+                  "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match.
+                  "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object.
+                    "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
+                  },
+                  "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties.
+                    "A String",
+                  ],
+                  "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring
+                  "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present.
+                    "A String",
+                  ],
+                  "title": "A String", # Optional. Title for the schema.
+                  "type": "A String", # Optional. Data type of the schema field.
+                },
+                "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration.
+                  "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request.
+                    "modelRoutingPreference": "A String", # The model routing preference.
+                  },
+                  "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually.
+                    "modelName": "A String", # The name of the model to use. Only public LLM models are accepted.
+                  },
+                },
+                "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results.
+                "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config.
+                  "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis.
+                  "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+                    "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+                      { # Configuration for a single speaker in a multi-speaker setup.
+                        "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+                        "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker.
+                          "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice.
+                            "voiceName": "A String", # The name of the prebuilt voice to use.
+                          },
+                          "replicatedVoiceConfig": { # The configuration for the replicated voice to use. # Optional. The configuration for a replicated voice. This enables users to replicate a voice from an audio sample.
+                            "mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set.
+                            "voiceSampleAudio": "A String", # Optional. The sample of the custom voice.
+                          },
+                        },
+                      },
+                    ],
+                  },
+                  "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use.
+                    "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice.
+                      "voiceName": "A String", # The name of the prebuilt voice to use.
+                    },
+                    "replicatedVoiceConfig": { # The configuration for the replicated voice to use. # Optional. The configuration for a replicated voice. This enables users to replicate a voice from an audio sample.
+                      "mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set.
+                      "voiceSampleAudio": "A String", # Optional. The sample of the custom voice.
+                    },
+                  },
+                },
+                "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker.
+                  "A String",
+                ],
+                "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0].
+                "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking.
+                  "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available.
+                  "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency.
+                  "thinkingLevel": "A String", # Optional. The number of thoughts tokens that the model should generate.
+                },
+                "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words.
+                "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both.
+              },
+              "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32.
+            },
+            "promptTemplate": "A String", # Template for the prompt used to generate rubrics. The details should be updated based on the most-recent recipe requirements.
+            "rubricContentType": "A String", # The type of rubric content to be generated.
+            "rubricTypeOntology": [ # Optional. An optional, pre-defined list of allowed types for generated rubrics. If this field is provided, it implies `include_rubric_type` should be true, and the generated rubric types should be chosen from this ontology.
+              "A String",
+            ],
+          },
+          "rubricGroupKey": "A String", # Use a pre-defined group of rubrics associated with the input. Refers to a key in the rubric_groups map of EvaluationInstance.
+          "systemInstruction": "A String", # Optional. System instructions for the judge model.
+        },
+        "metadata": { # Metadata about the metric, used for visualization and organization. # Optional. Metadata about the metric, used for visualization and organization.
+          "otherMetadata": { # Optional. Flexible metadata for user-defined attributes.
+            "a_key": "", # Properties of the object.
+          },
+          "scoreRange": { # The range of possible scores for this metric, used for plotting. # Optional. The range of possible scores for this metric, used for plotting.
+            "description": "A String", # Optional. The description of the score explaining the directionality etc.
+            "max": 3.14, # Required. The maximum value of the score range (inclusive).
+            "min": 3.14, # Required. The minimum value of the score range (inclusive).
+            "step": 3.14, # Optional. The distance between discrete steps in the range. If unset, the range is assumed to be continuous.
+          },
+          "title": "A String", # Optional. The user-friendly name for the metric. If not set for a registered metric, it will default to the metric's display name.
+        },
+        "pairwiseMetricSpec": { # Spec for pairwise metric. # Spec for pairwise metric.
+          "baselineResponseFieldName": "A String", # Optional. The field name of the baseline response.
+          "candidateResponseFieldName": "A String", # Optional. The field name of the candidate response.
+          "customOutputFormatConfig": { # Spec for custom output format configuration. # Optional. CustomOutputFormatConfig allows customization of metric output. When this config is set, the default output is replaced with the raw output string. If a custom format is chosen, the `pairwise_choice` and `explanation` fields in the corresponding metric result will be empty.
+            "returnRawOutput": True or False, # Optional. Whether to return raw output.
+          },
+          "metricPromptTemplate": "A String", # Required. Metric prompt template for pairwise metric.
+          "systemInstruction": "A String", # Optional. System instructions for pairwise metric.
+        },
+        "pointwiseMetricSpec": { # Spec for pointwise metric. # Spec for pointwise metric.
+          "customOutputFormatConfig": { # Spec for custom output format configuration. # Optional. CustomOutputFormatConfig allows customization of metric output. By default, metrics return a score and explanation. When this config is set, the default output is replaced with either: - The raw output string. - A parsed output based on a user-defined schema. If a custom format is chosen, the `score` and `explanation` fields in the corresponding metric result will be empty.
+            "returnRawOutput": True or False, # Optional. Whether to return raw output.
+          },
+          "metricPromptTemplate": "A String", # Required. Metric prompt template for pointwise metric.
+          "systemInstruction": "A String", # Optional. System instructions for pointwise metric.
+        },
+        "predefinedMetricSpec": { # The spec for a pre-defined metric. # The spec for a pre-defined metric.
+          "metricSpecName": "A String", # Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1".
+          "metricSpecParameters": { # Optional. The parameters needed to run the pre-defined metric.
+            "a_key": "", # Properties of the object.
+          },
+        },
+        "rougeSpec": { # Spec for rouge score metric - calculates the recall of n-grams in prediction as compared to reference - returns a score ranging between 0 and 1. # Spec for rouge metric.
+          "rougeType": "A String", # Optional. Supported rouge types are rougen[1-9], rougeL, and rougeLsum.
+          "splitSummaries": True or False, # Optional. Whether to split summaries while using rougeLsum.
+          "useStemmer": True or False, # Optional. Whether to use stemmer to compute rouge score.
+        },
+      },
+      "metricResourceName": "A String", # Resource name for registered metric.
+    },
+  ],
+  "name": "A String", # Identifier. The resource name of the OnlineEvaluator. Format: projects/{project}/locations/{location}/onlineEvaluators/{id}.
+  "state": "A String", # Output only. The state of the OnlineEvaluator.
+  "updateTime": "A String", # Output only. Timestamp when the OnlineEvaluator was last updated.
+}
+
+  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, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ delete(name, x__xgafv=None) +
Deletes an OnlineEvaluator.
+
+Args:
+  name: string, Required. The name of the OnlineEvaluator to delete. Format: projects/{project}/locations/{location}/onlineEvaluators/{id}. (required)
+  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, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ get(name, x__xgafv=None) +
Gets details of an OnlineEvaluator.
+
+Args:
+  name: string, Required. The name of the OnlineEvaluator to retrieve. Format: projects/{project}/locations/{location}/onlineEvaluators/{id}. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An OnlineEvaluator contains the configuration for an Online Evaluation.
+  "agentResource": "A String", # Required. Immutable. The name of the agent that the OnlineEvaluator evaluates periodically. This value is used to filter the traces with a matching cloud.resource_id and link the evaluation results with relevant dashboards/UIs. This field is immutable. Once set, it cannot be changed.
+  "cloudObservability": { # Data source for the OnlineEvaluator, based on GCP Observability stack (Cloud Trace & Cloud Logging). # Data source for the OnlineEvaluator, based on GCP Observability stack (Cloud Trace & Cloud Logging).
+    "logView": "A String", # Optional. Optional log view that will be used to query logs. If empty, the `_Default` view will be used.
+    "openTelemetry": { # Configuration for data source following OpenTelemetry. # Data source follows OpenTelemetry convention.
+      "semconvVersion": "A String", # Required. Defines which version OTel Semantic Convention the data follows. Can be "1.39.0" or newer.
+    },
+    "traceScope": { # Defines the scope and filters for selecting traces. # Scope online evaluation to single traces.
+      "filter": [ # Optional. A list of predicates to filter traces. Multiple predicates are combined using AND.
+        { # Defines a single filter predicate.
+          "duration": { # Defines a predicate for filtering based on a numeric value. # Filter on the duration of a trace.
+            "comparisonOperator": "A String", # Required. The comparison operator to apply.
+            "value": 3.14, # Required. The value to compare against.
+          },
+          "totalTokenUsage": { # Defines a predicate for filtering based on a numeric value. # Filter on the total token usage within a trace.
+            "comparisonOperator": "A String", # Required. The comparison operator to apply.
+            "value": 3.14, # Required. The value to compare against.
+          },
+        },
+      ],
+    },
+    "traceView": "A String", # Optional. Optional trace view that will be used to query traces. If empty, the `_Default` view will be used.
+  },
+  "config": { # Configuration for sampling behavior of the OnlineEvaluator. The OnlineEvaluator runs at a fixed interval of 10 minutes. # Required. Configuration for the OnlineEvaluator.
+    "maxEvaluatedSamplesPerRun": "A String", # Optional. The maximum number of evaluations to perform per run. If set to 0, the number is unbounded.
+    "randomSampling": { # Configuration for random sampling. # Random sampling method.
+      "percentage": 42, # Required. The percentage of traces to sample for evaluation. Must be an integer between 0 and 100.
+    },
+  },
+  "createTime": "A String", # Output only. Timestamp when the OnlineEvaluator was created.
+  "displayName": "A String", # Optional. Human-readable name for the `OnlineEvaluator`. The name doesn't have to be unique. The name can consist of any UTF-8 characters. The maximum length is `63` characters. If the display name exceeds max characters, an `INVALID_ARGUMENT` error is returned.
+  "metricSources": [ # Required. A list of metric sources to be used for evaluating samples. At least one MetricSource must be provided.
+    { # The metric source used for evaluation.
+      "metric": { # The metric used for running evaluations. # Inline metric config.
+        "aggregationMetrics": [ # Optional. The aggregation metrics to use.
+          "A String",
+        ],
+        "bleuSpec": { # Spec for bleu score metric - calculates the precision of n-grams in the prediction as compared to reference - returns a score ranging between 0 to 1. # Spec for bleu metric.
+          "useEffectiveOrder": True or False, # Optional. Whether to use_effective_order to compute bleu score.
+        },
+        "computationBasedMetricSpec": { # Specification for a computation based metric. # Spec for a computation based metric.
+          "parameters": { # Optional. A map of parameters for the metric, e.g. {"rouge_type": "rougeL"}.
+            "a_key": "", # Properties of the object.
+          },
+          "type": "A String", # Required. The type of the computation based metric.
+        },
+        "customCodeExecutionSpec": { # Specificies a metric that is populated by evaluating user-defined Python code. # Spec for Custom Code Execution metric.
+          "evaluationFunction": "A String", # Required. Python function. Expected user to define the following function, e.g.: def evaluate(instance: dict[str, Any]) -> float: Please include this function signature in the code snippet. Instance is the evaluation instance, any fields populated in the instance are available to the function as instance[field_name]. Example: Example input: ``` instance= EvaluationInstance( response=EvaluationInstance.InstanceData(text="The answer is 4."), reference=EvaluationInstance.InstanceData(text="4") ) ``` Example converted input: ``` { 'response': {'text': 'The answer is 4.'}, 'reference': {'text': '4'} } ``` Example python function: ``` def evaluate(instance: dict[str, Any]) -> float: if instance'response' == instance'reference': return 1.0 return 0.0 ``` CustomCodeExecutionSpec is also supported in Batch Evaluation (EvalDataset RPC) and Tuning Evaluation. Each line in the input jsonl file will be converted to dict[str, Any] and passed to the evaluation function.
+        },
+        "exactMatchSpec": { # Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0. # Spec for exact match metric.
+        },
+        "llmBasedMetricSpec": { # Specification for an LLM based metric. # Spec for an LLM based metric.
+          "additionalConfig": { # Optional. Optional additional configuration for the metric.
+            "a_key": "", # Properties of the object.
+          },
+          "judgeAutoraterConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Optional. Optional configuration for the judge LLM (Autorater).
+            "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
+            "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias.
+            "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs.
+              "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response.
+              "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one.
+              "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response.
+              "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0].
+              "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features.
+                "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+                "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images.
+                  "compressionQuality": 42, # Optional. The compression quality of the output image.
+                  "mimeType": "A String", # Optional. The image format that the output should be saved as.
+                },
+                "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`.
+                "personGeneration": "A String", # Optional. Controls whether the model can generate people.
+                "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people.
+              },
+              "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response.
+              "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses.
+              "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model.
+              "modelConfig": { # Config for model selection. # Optional. Config for model selection.
+                "featureSelectionPreference": "A String", # Required. Feature selection preference.
+              },
+              "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0].
+              "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`.
+              "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging.
+              "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined.
+              "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image.
+                "A String",
+              ],
+              "responseSchema": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`.
+                "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema.
+                "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`.
+                  # Object with schema name: GoogleCloudAiplatformV1beta1Schema
+                ],
+                "default": "", # Optional. Default value to use if the field is not specified.
+                "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema.
+                  "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
+                },
+                "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt.
+                "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}`
+                  "A String",
+                ],
+                "example": "", # Optional. Example of an instance of this schema.
+                "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type.
+                "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array.
+                "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array.
+                "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string.
+                "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided.
+                "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value.
+                "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array.
+                "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string.
+                "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided.
+                "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value.
+                "nullable": True or False, # Optional. Indicates if the value of this field can be null.
+                "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match.
+                "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object.
+                  "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
+                },
+                "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties.
+                  "A String",
+                ],
+                "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring
+                "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present.
+                  "A String",
+                ],
+                "title": "A String", # Optional. Title for the schema.
+                "type": "A String", # Optional. Data type of the schema field.
+              },
+              "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration.
+                "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request.
+                  "modelRoutingPreference": "A String", # The model routing preference.
+                },
+                "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually.
+                  "modelName": "A String", # The name of the model to use. Only public LLM models are accepted.
+                },
+              },
+              "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results.
+              "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config.
+                "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis.
+                "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+                  "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+                    { # Configuration for a single speaker in a multi-speaker setup.
+                      "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+                      "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker.
+                        "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice.
+                          "voiceName": "A String", # The name of the prebuilt voice to use.
+                        },
+                        "replicatedVoiceConfig": { # The configuration for the replicated voice to use. # Optional. The configuration for a replicated voice. This enables users to replicate a voice from an audio sample.
+                          "mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set.
+                          "voiceSampleAudio": "A String", # Optional. The sample of the custom voice.
+                        },
+                      },
+                    },
+                  ],
+                },
+                "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use.
+                  "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice.
+                    "voiceName": "A String", # The name of the prebuilt voice to use.
+                  },
+                  "replicatedVoiceConfig": { # The configuration for the replicated voice to use. # Optional. The configuration for a replicated voice. This enables users to replicate a voice from an audio sample.
+                    "mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set.
+                    "voiceSampleAudio": "A String", # Optional. The sample of the custom voice.
+                  },
+                },
+              },
+              "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker.
+                "A String",
+              ],
+              "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0].
+              "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking.
+                "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available.
+                "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency.
+                "thinkingLevel": "A String", # Optional. The number of thoughts tokens that the model should generate.
+              },
+              "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words.
+              "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both.
+            },
+            "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32.
+          },
+          "metricPromptTemplate": "A String", # Required. Template for the prompt sent to the judge model.
+          "predefinedRubricGenerationSpec": { # The spec for a pre-defined metric. # Dynamically generate rubrics using a predefined spec.
+            "metricSpecName": "A String", # Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1".
+            "metricSpecParameters": { # Optional. The parameters needed to run the pre-defined metric.
+              "a_key": "", # Properties of the object.
+            },
+          },
+          "rubricGenerationSpec": { # Specification for how rubrics should be generated. # Dynamically generate rubrics using this specification.
+            "modelConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation.
+              "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
+              "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias.
+              "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs.
+                "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response.
+                "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one.
+                "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response.
+                "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0].
+                "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features.
+                  "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+                  "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images.
+                    "compressionQuality": 42, # Optional. The compression quality of the output image.
+                    "mimeType": "A String", # Optional. The image format that the output should be saved as.
+                  },
+                  "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`.
+                  "personGeneration": "A String", # Optional. Controls whether the model can generate people.
+                  "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people.
+                },
+                "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response.
+                "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses.
+                "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model.
+                "modelConfig": { # Config for model selection. # Optional. Config for model selection.
+                  "featureSelectionPreference": "A String", # Required. Feature selection preference.
+                },
+                "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0].
+                "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`.
+                "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging.
+                "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined.
+                "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image.
+                  "A String",
+                ],
+                "responseSchema": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`.
+                  "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema.
+                  "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`.
+                    # Object with schema name: GoogleCloudAiplatformV1beta1Schema
+                  ],
+                  "default": "", # Optional. Default value to use if the field is not specified.
+                  "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema.
+                    "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
+                  },
+                  "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt.
+                  "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}`
+                    "A String",
+                  ],
+                  "example": "", # Optional. Example of an instance of this schema.
+                  "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type.
+                  "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array.
+                  "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array.
+                  "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string.
+                  "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided.
+                  "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value.
+                  "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array.
+                  "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string.
+                  "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided.
+                  "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value.
+                  "nullable": True or False, # Optional. Indicates if the value of this field can be null.
+                  "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match.
+                  "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object.
+                    "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
+                  },
+                  "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties.
+                    "A String",
+                  ],
+                  "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring
+                  "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present.
+                    "A String",
+                  ],
+                  "title": "A String", # Optional. Title for the schema.
+                  "type": "A String", # Optional. Data type of the schema field.
+                },
+                "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration.
+                  "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request.
+                    "modelRoutingPreference": "A String", # The model routing preference.
+                  },
+                  "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually.
+                    "modelName": "A String", # The name of the model to use. Only public LLM models are accepted.
+                  },
+                },
+                "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results.
+                "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config.
+                  "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis.
+                  "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+                    "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+                      { # Configuration for a single speaker in a multi-speaker setup.
+                        "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+                        "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker.
+                          "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice.
+                            "voiceName": "A String", # The name of the prebuilt voice to use.
+                          },
+                          "replicatedVoiceConfig": { # The configuration for the replicated voice to use. # Optional. The configuration for a replicated voice. This enables users to replicate a voice from an audio sample.
+                            "mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set.
+                            "voiceSampleAudio": "A String", # Optional. The sample of the custom voice.
+                          },
+                        },
+                      },
+                    ],
+                  },
+                  "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use.
+                    "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice.
+                      "voiceName": "A String", # The name of the prebuilt voice to use.
+                    },
+                    "replicatedVoiceConfig": { # The configuration for the replicated voice to use. # Optional. The configuration for a replicated voice. This enables users to replicate a voice from an audio sample.
+                      "mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set.
+                      "voiceSampleAudio": "A String", # Optional. The sample of the custom voice.
+                    },
+                  },
+                },
+                "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker.
+                  "A String",
+                ],
+                "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0].
+                "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking.
+                  "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available.
+                  "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency.
+                  "thinkingLevel": "A String", # Optional. The number of thoughts tokens that the model should generate.
+                },
+                "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words.
+                "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both.
+              },
+              "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32.
+            },
+            "promptTemplate": "A String", # Template for the prompt used to generate rubrics. The details should be updated based on the most-recent recipe requirements.
+            "rubricContentType": "A String", # The type of rubric content to be generated.
+            "rubricTypeOntology": [ # Optional. An optional, pre-defined list of allowed types for generated rubrics. If this field is provided, it implies `include_rubric_type` should be true, and the generated rubric types should be chosen from this ontology.
+              "A String",
+            ],
+          },
+          "rubricGroupKey": "A String", # Use a pre-defined group of rubrics associated with the input. Refers to a key in the rubric_groups map of EvaluationInstance.
+          "systemInstruction": "A String", # Optional. System instructions for the judge model.
+        },
+        "metadata": { # Metadata about the metric, used for visualization and organization. # Optional. Metadata about the metric, used for visualization and organization.
+          "otherMetadata": { # Optional. Flexible metadata for user-defined attributes.
+            "a_key": "", # Properties of the object.
+          },
+          "scoreRange": { # The range of possible scores for this metric, used for plotting. # Optional. The range of possible scores for this metric, used for plotting.
+            "description": "A String", # Optional. The description of the score explaining the directionality etc.
+            "max": 3.14, # Required. The maximum value of the score range (inclusive).
+            "min": 3.14, # Required. The minimum value of the score range (inclusive).
+            "step": 3.14, # Optional. The distance between discrete steps in the range. If unset, the range is assumed to be continuous.
+          },
+          "title": "A String", # Optional. The user-friendly name for the metric. If not set for a registered metric, it will default to the metric's display name.
+        },
+        "pairwiseMetricSpec": { # Spec for pairwise metric. # Spec for pairwise metric.
+          "baselineResponseFieldName": "A String", # Optional. The field name of the baseline response.
+          "candidateResponseFieldName": "A String", # Optional. The field name of the candidate response.
+          "customOutputFormatConfig": { # Spec for custom output format configuration. # Optional. CustomOutputFormatConfig allows customization of metric output. When this config is set, the default output is replaced with the raw output string. If a custom format is chosen, the `pairwise_choice` and `explanation` fields in the corresponding metric result will be empty.
+            "returnRawOutput": True or False, # Optional. Whether to return raw output.
+          },
+          "metricPromptTemplate": "A String", # Required. Metric prompt template for pairwise metric.
+          "systemInstruction": "A String", # Optional. System instructions for pairwise metric.
+        },
+        "pointwiseMetricSpec": { # Spec for pointwise metric. # Spec for pointwise metric.
+          "customOutputFormatConfig": { # Spec for custom output format configuration. # Optional. CustomOutputFormatConfig allows customization of metric output. By default, metrics return a score and explanation. When this config is set, the default output is replaced with either: - The raw output string. - A parsed output based on a user-defined schema. If a custom format is chosen, the `score` and `explanation` fields in the corresponding metric result will be empty.
+            "returnRawOutput": True or False, # Optional. Whether to return raw output.
+          },
+          "metricPromptTemplate": "A String", # Required. Metric prompt template for pointwise metric.
+          "systemInstruction": "A String", # Optional. System instructions for pointwise metric.
+        },
+        "predefinedMetricSpec": { # The spec for a pre-defined metric. # The spec for a pre-defined metric.
+          "metricSpecName": "A String", # Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1".
+          "metricSpecParameters": { # Optional. The parameters needed to run the pre-defined metric.
+            "a_key": "", # Properties of the object.
+          },
+        },
+        "rougeSpec": { # Spec for rouge score metric - calculates the recall of n-grams in prediction as compared to reference - returns a score ranging between 0 and 1. # Spec for rouge metric.
+          "rougeType": "A String", # Optional. Supported rouge types are rougen[1-9], rougeL, and rougeLsum.
+          "splitSummaries": True or False, # Optional. Whether to split summaries while using rougeLsum.
+          "useStemmer": True or False, # Optional. Whether to use stemmer to compute rouge score.
+        },
+      },
+      "metricResourceName": "A String", # Resource name for registered metric.
+    },
+  ],
+  "name": "A String", # Identifier. The resource name of the OnlineEvaluator. Format: projects/{project}/locations/{location}/onlineEvaluators/{id}.
+  "state": "A String", # Output only. The state of the OnlineEvaluator.
+  "updateTime": "A String", # Output only. Timestamp when the OnlineEvaluator was last updated.
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists the OnlineEvaluators for the given project and location.
+
+Args:
+  parent: string, Required. The parent resource of the OnlineEvaluators to list. Format: projects/{project}/locations/{location}. (required)
+  filter: string, Optional. Standard list filter. Supported fields: * `create_time` * `update_time` * `agent_resource` Example: `create_time>"2026-01-01T00:00:00-04:00"` where the timestamp is in RFC 3339 format) Based on aip.dev/160.
+  orderBy: string, Optional. A comma-separated list of fields to order by. The default sorting order is ascending. Use "desc" after a field name for descending. Supported fields: * `create_time` * `update_time` Example: `create_time desc`. Based on aip.dev/132.
+  pageSize: integer, Optional. The maximum number of OnlineEvaluators to return. The service may return fewer than this value. If unspecified, at most 50 OnlineEvaluators will be returned. The maximum value is 100; values above 100 will be coerced to 100. Based on aip.dev/158.
+  pageToken: string, Optional. A token identifying a page of results the server should return. Based on aip.dev/158.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for ListOnlineEvaluators.
+  "nextPageToken": "A String", # A token to retrieve the next page. Absence of this field indicates there are no subsequent pages.
+  "onlineEvaluators": [ # A list of OnlineEvaluators matching the request.
+    { # An OnlineEvaluator contains the configuration for an Online Evaluation.
+      "agentResource": "A String", # Required. Immutable. The name of the agent that the OnlineEvaluator evaluates periodically. This value is used to filter the traces with a matching cloud.resource_id and link the evaluation results with relevant dashboards/UIs. This field is immutable. Once set, it cannot be changed.
+      "cloudObservability": { # Data source for the OnlineEvaluator, based on GCP Observability stack (Cloud Trace & Cloud Logging). # Data source for the OnlineEvaluator, based on GCP Observability stack (Cloud Trace & Cloud Logging).
+        "logView": "A String", # Optional. Optional log view that will be used to query logs. If empty, the `_Default` view will be used.
+        "openTelemetry": { # Configuration for data source following OpenTelemetry. # Data source follows OpenTelemetry convention.
+          "semconvVersion": "A String", # Required. Defines which version OTel Semantic Convention the data follows. Can be "1.39.0" or newer.
+        },
+        "traceScope": { # Defines the scope and filters for selecting traces. # Scope online evaluation to single traces.
+          "filter": [ # Optional. A list of predicates to filter traces. Multiple predicates are combined using AND.
+            { # Defines a single filter predicate.
+              "duration": { # Defines a predicate for filtering based on a numeric value. # Filter on the duration of a trace.
+                "comparisonOperator": "A String", # Required. The comparison operator to apply.
+                "value": 3.14, # Required. The value to compare against.
+              },
+              "totalTokenUsage": { # Defines a predicate for filtering based on a numeric value. # Filter on the total token usage within a trace.
+                "comparisonOperator": "A String", # Required. The comparison operator to apply.
+                "value": 3.14, # Required. The value to compare against.
+              },
+            },
+          ],
+        },
+        "traceView": "A String", # Optional. Optional trace view that will be used to query traces. If empty, the `_Default` view will be used.
+      },
+      "config": { # Configuration for sampling behavior of the OnlineEvaluator. The OnlineEvaluator runs at a fixed interval of 10 minutes. # Required. Configuration for the OnlineEvaluator.
+        "maxEvaluatedSamplesPerRun": "A String", # Optional. The maximum number of evaluations to perform per run. If set to 0, the number is unbounded.
+        "randomSampling": { # Configuration for random sampling. # Random sampling method.
+          "percentage": 42, # Required. The percentage of traces to sample for evaluation. Must be an integer between 0 and 100.
+        },
+      },
+      "createTime": "A String", # Output only. Timestamp when the OnlineEvaluator was created.
+      "displayName": "A String", # Optional. Human-readable name for the `OnlineEvaluator`. The name doesn't have to be unique. The name can consist of any UTF-8 characters. The maximum length is `63` characters. If the display name exceeds max characters, an `INVALID_ARGUMENT` error is returned.
+      "metricSources": [ # Required. A list of metric sources to be used for evaluating samples. At least one MetricSource must be provided.
+        { # The metric source used for evaluation.
+          "metric": { # The metric used for running evaluations. # Inline metric config.
+            "aggregationMetrics": [ # Optional. The aggregation metrics to use.
+              "A String",
+            ],
+            "bleuSpec": { # Spec for bleu score metric - calculates the precision of n-grams in the prediction as compared to reference - returns a score ranging between 0 to 1. # Spec for bleu metric.
+              "useEffectiveOrder": True or False, # Optional. Whether to use_effective_order to compute bleu score.
+            },
+            "computationBasedMetricSpec": { # Specification for a computation based metric. # Spec for a computation based metric.
+              "parameters": { # Optional. A map of parameters for the metric, e.g. {"rouge_type": "rougeL"}.
+                "a_key": "", # Properties of the object.
+              },
+              "type": "A String", # Required. The type of the computation based metric.
+            },
+            "customCodeExecutionSpec": { # Specificies a metric that is populated by evaluating user-defined Python code. # Spec for Custom Code Execution metric.
+              "evaluationFunction": "A String", # Required. Python function. Expected user to define the following function, e.g.: def evaluate(instance: dict[str, Any]) -> float: Please include this function signature in the code snippet. Instance is the evaluation instance, any fields populated in the instance are available to the function as instance[field_name]. Example: Example input: ``` instance= EvaluationInstance( response=EvaluationInstance.InstanceData(text="The answer is 4."), reference=EvaluationInstance.InstanceData(text="4") ) ``` Example converted input: ``` { 'response': {'text': 'The answer is 4.'}, 'reference': {'text': '4'} } ``` Example python function: ``` def evaluate(instance: dict[str, Any]) -> float: if instance'response' == instance'reference': return 1.0 return 0.0 ``` CustomCodeExecutionSpec is also supported in Batch Evaluation (EvalDataset RPC) and Tuning Evaluation. Each line in the input jsonl file will be converted to dict[str, Any] and passed to the evaluation function.
+            },
+            "exactMatchSpec": { # Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0. # Spec for exact match metric.
+            },
+            "llmBasedMetricSpec": { # Specification for an LLM based metric. # Spec for an LLM based metric.
+              "additionalConfig": { # Optional. Optional additional configuration for the metric.
+                "a_key": "", # Properties of the object.
+              },
+              "judgeAutoraterConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Optional. Optional configuration for the judge LLM (Autorater).
+                "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
+                "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias.
+                "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs.
+                  "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response.
+                  "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one.
+                  "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response.
+                  "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0].
+                  "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features.
+                    "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+                    "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images.
+                      "compressionQuality": 42, # Optional. The compression quality of the output image.
+                      "mimeType": "A String", # Optional. The image format that the output should be saved as.
+                    },
+                    "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`.
+                    "personGeneration": "A String", # Optional. Controls whether the model can generate people.
+                    "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people.
+                  },
+                  "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response.
+                  "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses.
+                  "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model.
+                  "modelConfig": { # Config for model selection. # Optional. Config for model selection.
+                    "featureSelectionPreference": "A String", # Required. Feature selection preference.
+                  },
+                  "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0].
+                  "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`.
+                  "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging.
+                  "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined.
+                  "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image.
+                    "A String",
+                  ],
+                  "responseSchema": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`.
+                    "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema.
+                    "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`.
+                      # Object with schema name: GoogleCloudAiplatformV1beta1Schema
+                    ],
+                    "default": "", # Optional. Default value to use if the field is not specified.
+                    "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema.
+                      "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
+                    },
+                    "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt.
+                    "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}`
+                      "A String",
+                    ],
+                    "example": "", # Optional. Example of an instance of this schema.
+                    "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type.
+                    "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array.
+                    "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array.
+                    "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string.
+                    "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided.
+                    "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value.
+                    "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array.
+                    "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string.
+                    "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided.
+                    "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value.
+                    "nullable": True or False, # Optional. Indicates if the value of this field can be null.
+                    "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match.
+                    "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object.
+                      "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
+                    },
+                    "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties.
+                      "A String",
+                    ],
+                    "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring
+                    "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present.
+                      "A String",
+                    ],
+                    "title": "A String", # Optional. Title for the schema.
+                    "type": "A String", # Optional. Data type of the schema field.
+                  },
+                  "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration.
+                    "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request.
+                      "modelRoutingPreference": "A String", # The model routing preference.
+                    },
+                    "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually.
+                      "modelName": "A String", # The name of the model to use. Only public LLM models are accepted.
+                    },
+                  },
+                  "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results.
+                  "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config.
+                    "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis.
+                    "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+                      "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+                        { # Configuration for a single speaker in a multi-speaker setup.
+                          "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+                          "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker.
+                            "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice.
+                              "voiceName": "A String", # The name of the prebuilt voice to use.
+                            },
+                            "replicatedVoiceConfig": { # The configuration for the replicated voice to use. # Optional. The configuration for a replicated voice. This enables users to replicate a voice from an audio sample.
+                              "mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set.
+                              "voiceSampleAudio": "A String", # Optional. The sample of the custom voice.
+                            },
+                          },
+                        },
+                      ],
+                    },
+                    "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use.
+                      "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice.
+                        "voiceName": "A String", # The name of the prebuilt voice to use.
+                      },
+                      "replicatedVoiceConfig": { # The configuration for the replicated voice to use. # Optional. The configuration for a replicated voice. This enables users to replicate a voice from an audio sample.
+                        "mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set.
+                        "voiceSampleAudio": "A String", # Optional. The sample of the custom voice.
+                      },
+                    },
+                  },
+                  "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker.
+                    "A String",
+                  ],
+                  "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0].
+                  "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking.
+                    "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available.
+                    "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency.
+                    "thinkingLevel": "A String", # Optional. The number of thoughts tokens that the model should generate.
+                  },
+                  "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words.
+                  "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both.
+                },
+                "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32.
+              },
+              "metricPromptTemplate": "A String", # Required. Template for the prompt sent to the judge model.
+              "predefinedRubricGenerationSpec": { # The spec for a pre-defined metric. # Dynamically generate rubrics using a predefined spec.
+                "metricSpecName": "A String", # Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1".
+                "metricSpecParameters": { # Optional. The parameters needed to run the pre-defined metric.
+                  "a_key": "", # Properties of the object.
+                },
+              },
+              "rubricGenerationSpec": { # Specification for how rubrics should be generated. # Dynamically generate rubrics using this specification.
+                "modelConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation.
+                  "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
+                  "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias.
+                  "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs.
+                    "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response.
+                    "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one.
+                    "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response.
+                    "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0].
+                    "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features.
+                      "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+                      "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images.
+                        "compressionQuality": 42, # Optional. The compression quality of the output image.
+                        "mimeType": "A String", # Optional. The image format that the output should be saved as.
+                      },
+                      "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`.
+                      "personGeneration": "A String", # Optional. Controls whether the model can generate people.
+                      "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people.
+                    },
+                    "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response.
+                    "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses.
+                    "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model.
+                    "modelConfig": { # Config for model selection. # Optional. Config for model selection.
+                      "featureSelectionPreference": "A String", # Required. Feature selection preference.
+                    },
+                    "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0].
+                    "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`.
+                    "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging.
+                    "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined.
+                    "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image.
+                      "A String",
+                    ],
+                    "responseSchema": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`.
+                      "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema.
+                      "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`.
+                        # Object with schema name: GoogleCloudAiplatformV1beta1Schema
+                      ],
+                      "default": "", # Optional. Default value to use if the field is not specified.
+                      "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema.
+                        "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
+                      },
+                      "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt.
+                      "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}`
+                        "A String",
+                      ],
+                      "example": "", # Optional. Example of an instance of this schema.
+                      "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type.
+                      "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array.
+                      "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array.
+                      "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string.
+                      "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided.
+                      "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value.
+                      "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array.
+                      "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string.
+                      "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided.
+                      "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value.
+                      "nullable": True or False, # Optional. Indicates if the value of this field can be null.
+                      "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match.
+                      "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object.
+                        "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
+                      },
+                      "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties.
+                        "A String",
+                      ],
+                      "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring
+                      "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present.
+                        "A String",
+                      ],
+                      "title": "A String", # Optional. Title for the schema.
+                      "type": "A String", # Optional. Data type of the schema field.
+                    },
+                    "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration.
+                      "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request.
+                        "modelRoutingPreference": "A String", # The model routing preference.
+                      },
+                      "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually.
+                        "modelName": "A String", # The name of the model to use. Only public LLM models are accepted.
+                      },
+                    },
+                    "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results.
+                    "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config.
+                      "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis.
+                      "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+                        "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+                          { # Configuration for a single speaker in a multi-speaker setup.
+                            "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+                            "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker.
+                              "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice.
+                                "voiceName": "A String", # The name of the prebuilt voice to use.
+                              },
+                              "replicatedVoiceConfig": { # The configuration for the replicated voice to use. # Optional. The configuration for a replicated voice. This enables users to replicate a voice from an audio sample.
+                                "mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set.
+                                "voiceSampleAudio": "A String", # Optional. The sample of the custom voice.
+                              },
+                            },
+                          },
+                        ],
+                      },
+                      "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use.
+                        "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice.
+                          "voiceName": "A String", # The name of the prebuilt voice to use.
+                        },
+                        "replicatedVoiceConfig": { # The configuration for the replicated voice to use. # Optional. The configuration for a replicated voice. This enables users to replicate a voice from an audio sample.
+                          "mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set.
+                          "voiceSampleAudio": "A String", # Optional. The sample of the custom voice.
+                        },
+                      },
+                    },
+                    "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker.
+                      "A String",
+                    ],
+                    "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0].
+                    "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking.
+                      "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available.
+                      "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency.
+                      "thinkingLevel": "A String", # Optional. The number of thoughts tokens that the model should generate.
+                    },
+                    "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words.
+                    "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both.
+                  },
+                  "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32.
+                },
+                "promptTemplate": "A String", # Template for the prompt used to generate rubrics. The details should be updated based on the most-recent recipe requirements.
+                "rubricContentType": "A String", # The type of rubric content to be generated.
+                "rubricTypeOntology": [ # Optional. An optional, pre-defined list of allowed types for generated rubrics. If this field is provided, it implies `include_rubric_type` should be true, and the generated rubric types should be chosen from this ontology.
+                  "A String",
+                ],
+              },
+              "rubricGroupKey": "A String", # Use a pre-defined group of rubrics associated with the input. Refers to a key in the rubric_groups map of EvaluationInstance.
+              "systemInstruction": "A String", # Optional. System instructions for the judge model.
+            },
+            "metadata": { # Metadata about the metric, used for visualization and organization. # Optional. Metadata about the metric, used for visualization and organization.
+              "otherMetadata": { # Optional. Flexible metadata for user-defined attributes.
+                "a_key": "", # Properties of the object.
+              },
+              "scoreRange": { # The range of possible scores for this metric, used for plotting. # Optional. The range of possible scores for this metric, used for plotting.
+                "description": "A String", # Optional. The description of the score explaining the directionality etc.
+                "max": 3.14, # Required. The maximum value of the score range (inclusive).
+                "min": 3.14, # Required. The minimum value of the score range (inclusive).
+                "step": 3.14, # Optional. The distance between discrete steps in the range. If unset, the range is assumed to be continuous.
+              },
+              "title": "A String", # Optional. The user-friendly name for the metric. If not set for a registered metric, it will default to the metric's display name.
+            },
+            "pairwiseMetricSpec": { # Spec for pairwise metric. # Spec for pairwise metric.
+              "baselineResponseFieldName": "A String", # Optional. The field name of the baseline response.
+              "candidateResponseFieldName": "A String", # Optional. The field name of the candidate response.
+              "customOutputFormatConfig": { # Spec for custom output format configuration. # Optional. CustomOutputFormatConfig allows customization of metric output. When this config is set, the default output is replaced with the raw output string. If a custom format is chosen, the `pairwise_choice` and `explanation` fields in the corresponding metric result will be empty.
+                "returnRawOutput": True or False, # Optional. Whether to return raw output.
+              },
+              "metricPromptTemplate": "A String", # Required. Metric prompt template for pairwise metric.
+              "systemInstruction": "A String", # Optional. System instructions for pairwise metric.
+            },
+            "pointwiseMetricSpec": { # Spec for pointwise metric. # Spec for pointwise metric.
+              "customOutputFormatConfig": { # Spec for custom output format configuration. # Optional. CustomOutputFormatConfig allows customization of metric output. By default, metrics return a score and explanation. When this config is set, the default output is replaced with either: - The raw output string. - A parsed output based on a user-defined schema. If a custom format is chosen, the `score` and `explanation` fields in the corresponding metric result will be empty.
+                "returnRawOutput": True or False, # Optional. Whether to return raw output.
+              },
+              "metricPromptTemplate": "A String", # Required. Metric prompt template for pointwise metric.
+              "systemInstruction": "A String", # Optional. System instructions for pointwise metric.
+            },
+            "predefinedMetricSpec": { # The spec for a pre-defined metric. # The spec for a pre-defined metric.
+              "metricSpecName": "A String", # Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1".
+              "metricSpecParameters": { # Optional. The parameters needed to run the pre-defined metric.
+                "a_key": "", # Properties of the object.
+              },
+            },
+            "rougeSpec": { # Spec for rouge score metric - calculates the recall of n-grams in prediction as compared to reference - returns a score ranging between 0 and 1. # Spec for rouge metric.
+              "rougeType": "A String", # Optional. Supported rouge types are rougen[1-9], rougeL, and rougeLsum.
+              "splitSummaries": True or False, # Optional. Whether to split summaries while using rougeLsum.
+              "useStemmer": True or False, # Optional. Whether to use stemmer to compute rouge score.
+            },
+          },
+          "metricResourceName": "A String", # Resource name for registered metric.
+        },
+      ],
+      "name": "A String", # Identifier. The resource name of the OnlineEvaluator. Format: projects/{project}/locations/{location}/onlineEvaluators/{id}.
+      "state": "A String", # Output only. The state of the OnlineEvaluator.
+      "updateTime": "A String", # Output only. Timestamp when the OnlineEvaluator was last updated.
+    },
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) +
Updates the fields of an OnlineEvaluator.
+
+Args:
+  name: string, Identifier. The resource name of the OnlineEvaluator. Format: projects/{project}/locations/{location}/onlineEvaluators/{id}. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # An OnlineEvaluator contains the configuration for an Online Evaluation.
+  "agentResource": "A String", # Required. Immutable. The name of the agent that the OnlineEvaluator evaluates periodically. This value is used to filter the traces with a matching cloud.resource_id and link the evaluation results with relevant dashboards/UIs. This field is immutable. Once set, it cannot be changed.
+  "cloudObservability": { # Data source for the OnlineEvaluator, based on GCP Observability stack (Cloud Trace & Cloud Logging). # Data source for the OnlineEvaluator, based on GCP Observability stack (Cloud Trace & Cloud Logging).
+    "logView": "A String", # Optional. Optional log view that will be used to query logs. If empty, the `_Default` view will be used.
+    "openTelemetry": { # Configuration for data source following OpenTelemetry. # Data source follows OpenTelemetry convention.
+      "semconvVersion": "A String", # Required. Defines which version OTel Semantic Convention the data follows. Can be "1.39.0" or newer.
+    },
+    "traceScope": { # Defines the scope and filters for selecting traces. # Scope online evaluation to single traces.
+      "filter": [ # Optional. A list of predicates to filter traces. Multiple predicates are combined using AND.
+        { # Defines a single filter predicate.
+          "duration": { # Defines a predicate for filtering based on a numeric value. # Filter on the duration of a trace.
+            "comparisonOperator": "A String", # Required. The comparison operator to apply.
+            "value": 3.14, # Required. The value to compare against.
+          },
+          "totalTokenUsage": { # Defines a predicate for filtering based on a numeric value. # Filter on the total token usage within a trace.
+            "comparisonOperator": "A String", # Required. The comparison operator to apply.
+            "value": 3.14, # Required. The value to compare against.
+          },
+        },
+      ],
+    },
+    "traceView": "A String", # Optional. Optional trace view that will be used to query traces. If empty, the `_Default` view will be used.
+  },
+  "config": { # Configuration for sampling behavior of the OnlineEvaluator. The OnlineEvaluator runs at a fixed interval of 10 minutes. # Required. Configuration for the OnlineEvaluator.
+    "maxEvaluatedSamplesPerRun": "A String", # Optional. The maximum number of evaluations to perform per run. If set to 0, the number is unbounded.
+    "randomSampling": { # Configuration for random sampling. # Random sampling method.
+      "percentage": 42, # Required. The percentage of traces to sample for evaluation. Must be an integer between 0 and 100.
+    },
+  },
+  "createTime": "A String", # Output only. Timestamp when the OnlineEvaluator was created.
+  "displayName": "A String", # Optional. Human-readable name for the `OnlineEvaluator`. The name doesn't have to be unique. The name can consist of any UTF-8 characters. The maximum length is `63` characters. If the display name exceeds max characters, an `INVALID_ARGUMENT` error is returned.
+  "metricSources": [ # Required. A list of metric sources to be used for evaluating samples. At least one MetricSource must be provided.
+    { # The metric source used for evaluation.
+      "metric": { # The metric used for running evaluations. # Inline metric config.
+        "aggregationMetrics": [ # Optional. The aggregation metrics to use.
+          "A String",
+        ],
+        "bleuSpec": { # Spec for bleu score metric - calculates the precision of n-grams in the prediction as compared to reference - returns a score ranging between 0 to 1. # Spec for bleu metric.
+          "useEffectiveOrder": True or False, # Optional. Whether to use_effective_order to compute bleu score.
+        },
+        "computationBasedMetricSpec": { # Specification for a computation based metric. # Spec for a computation based metric.
+          "parameters": { # Optional. A map of parameters for the metric, e.g. {"rouge_type": "rougeL"}.
+            "a_key": "", # Properties of the object.
+          },
+          "type": "A String", # Required. The type of the computation based metric.
+        },
+        "customCodeExecutionSpec": { # Specificies a metric that is populated by evaluating user-defined Python code. # Spec for Custom Code Execution metric.
+          "evaluationFunction": "A String", # Required. Python function. Expected user to define the following function, e.g.: def evaluate(instance: dict[str, Any]) -> float: Please include this function signature in the code snippet. Instance is the evaluation instance, any fields populated in the instance are available to the function as instance[field_name]. Example: Example input: ``` instance= EvaluationInstance( response=EvaluationInstance.InstanceData(text="The answer is 4."), reference=EvaluationInstance.InstanceData(text="4") ) ``` Example converted input: ``` { 'response': {'text': 'The answer is 4.'}, 'reference': {'text': '4'} } ``` Example python function: ``` def evaluate(instance: dict[str, Any]) -> float: if instance'response' == instance'reference': return 1.0 return 0.0 ``` CustomCodeExecutionSpec is also supported in Batch Evaluation (EvalDataset RPC) and Tuning Evaluation. Each line in the input jsonl file will be converted to dict[str, Any] and passed to the evaluation function.
+        },
+        "exactMatchSpec": { # Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0. # Spec for exact match metric.
+        },
+        "llmBasedMetricSpec": { # Specification for an LLM based metric. # Spec for an LLM based metric.
+          "additionalConfig": { # Optional. Optional additional configuration for the metric.
+            "a_key": "", # Properties of the object.
+          },
+          "judgeAutoraterConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Optional. Optional configuration for the judge LLM (Autorater).
+            "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
+            "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias.
+            "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs.
+              "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response.
+              "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one.
+              "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response.
+              "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0].
+              "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features.
+                "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+                "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images.
+                  "compressionQuality": 42, # Optional. The compression quality of the output image.
+                  "mimeType": "A String", # Optional. The image format that the output should be saved as.
+                },
+                "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`.
+                "personGeneration": "A String", # Optional. Controls whether the model can generate people.
+                "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people.
+              },
+              "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response.
+              "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses.
+              "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model.
+              "modelConfig": { # Config for model selection. # Optional. Config for model selection.
+                "featureSelectionPreference": "A String", # Required. Feature selection preference.
+              },
+              "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0].
+              "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`.
+              "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging.
+              "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined.
+              "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image.
+                "A String",
+              ],
+              "responseSchema": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`.
+                "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema.
+                "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`.
+                  # Object with schema name: GoogleCloudAiplatformV1beta1Schema
+                ],
+                "default": "", # Optional. Default value to use if the field is not specified.
+                "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema.
+                  "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
+                },
+                "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt.
+                "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}`
+                  "A String",
+                ],
+                "example": "", # Optional. Example of an instance of this schema.
+                "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type.
+                "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array.
+                "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array.
+                "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string.
+                "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided.
+                "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value.
+                "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array.
+                "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string.
+                "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided.
+                "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value.
+                "nullable": True or False, # Optional. Indicates if the value of this field can be null.
+                "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match.
+                "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object.
+                  "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
+                },
+                "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties.
+                  "A String",
+                ],
+                "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring
+                "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present.
+                  "A String",
+                ],
+                "title": "A String", # Optional. Title for the schema.
+                "type": "A String", # Optional. Data type of the schema field.
+              },
+              "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration.
+                "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request.
+                  "modelRoutingPreference": "A String", # The model routing preference.
+                },
+                "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually.
+                  "modelName": "A String", # The name of the model to use. Only public LLM models are accepted.
+                },
+              },
+              "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results.
+              "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config.
+                "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis.
+                "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+                  "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+                    { # Configuration for a single speaker in a multi-speaker setup.
+                      "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+                      "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker.
+                        "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice.
+                          "voiceName": "A String", # The name of the prebuilt voice to use.
+                        },
+                        "replicatedVoiceConfig": { # The configuration for the replicated voice to use. # Optional. The configuration for a replicated voice. This enables users to replicate a voice from an audio sample.
+                          "mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set.
+                          "voiceSampleAudio": "A String", # Optional. The sample of the custom voice.
+                        },
+                      },
+                    },
+                  ],
+                },
+                "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use.
+                  "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice.
+                    "voiceName": "A String", # The name of the prebuilt voice to use.
+                  },
+                  "replicatedVoiceConfig": { # The configuration for the replicated voice to use. # Optional. The configuration for a replicated voice. This enables users to replicate a voice from an audio sample.
+                    "mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set.
+                    "voiceSampleAudio": "A String", # Optional. The sample of the custom voice.
+                  },
+                },
+              },
+              "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker.
+                "A String",
+              ],
+              "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0].
+              "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking.
+                "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available.
+                "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency.
+                "thinkingLevel": "A String", # Optional. The number of thoughts tokens that the model should generate.
+              },
+              "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words.
+              "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both.
+            },
+            "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32.
+          },
+          "metricPromptTemplate": "A String", # Required. Template for the prompt sent to the judge model.
+          "predefinedRubricGenerationSpec": { # The spec for a pre-defined metric. # Dynamically generate rubrics using a predefined spec.
+            "metricSpecName": "A String", # Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1".
+            "metricSpecParameters": { # Optional. The parameters needed to run the pre-defined metric.
+              "a_key": "", # Properties of the object.
+            },
+          },
+          "rubricGenerationSpec": { # Specification for how rubrics should be generated. # Dynamically generate rubrics using this specification.
+            "modelConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation.
+              "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
+              "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias.
+              "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs.
+                "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response.
+                "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one.
+                "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response.
+                "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0].
+                "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features.
+                  "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+                  "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images.
+                    "compressionQuality": 42, # Optional. The compression quality of the output image.
+                    "mimeType": "A String", # Optional. The image format that the output should be saved as.
+                  },
+                  "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`.
+                  "personGeneration": "A String", # Optional. Controls whether the model can generate people.
+                  "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people.
+                },
+                "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response.
+                "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses.
+                "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model.
+                "modelConfig": { # Config for model selection. # Optional. Config for model selection.
+                  "featureSelectionPreference": "A String", # Required. Feature selection preference.
+                },
+                "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0].
+                "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`.
+                "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging.
+                "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined.
+                "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image.
+                  "A String",
+                ],
+                "responseSchema": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`.
+                  "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema.
+                  "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`.
+                    # Object with schema name: GoogleCloudAiplatformV1beta1Schema
+                  ],
+                  "default": "", # Optional. Default value to use if the field is not specified.
+                  "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema.
+                    "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
+                  },
+                  "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt.
+                  "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}`
+                    "A String",
+                  ],
+                  "example": "", # Optional. Example of an instance of this schema.
+                  "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type.
+                  "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array.
+                  "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array.
+                  "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string.
+                  "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided.
+                  "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value.
+                  "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array.
+                  "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string.
+                  "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided.
+                  "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value.
+                  "nullable": True or False, # Optional. Indicates if the value of this field can be null.
+                  "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match.
+                  "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object.
+                    "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
+                  },
+                  "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties.
+                    "A String",
+                  ],
+                  "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring
+                  "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present.
+                    "A String",
+                  ],
+                  "title": "A String", # Optional. Title for the schema.
+                  "type": "A String", # Optional. Data type of the schema field.
+                },
+                "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration.
+                  "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request.
+                    "modelRoutingPreference": "A String", # The model routing preference.
+                  },
+                  "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually.
+                    "modelName": "A String", # The name of the model to use. Only public LLM models are accepted.
+                  },
+                },
+                "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results.
+                "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config.
+                  "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis.
+                  "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+                    "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+                      { # Configuration for a single speaker in a multi-speaker setup.
+                        "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+                        "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker.
+                          "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice.
+                            "voiceName": "A String", # The name of the prebuilt voice to use.
+                          },
+                          "replicatedVoiceConfig": { # The configuration for the replicated voice to use. # Optional. The configuration for a replicated voice. This enables users to replicate a voice from an audio sample.
+                            "mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set.
+                            "voiceSampleAudio": "A String", # Optional. The sample of the custom voice.
+                          },
+                        },
+                      },
+                    ],
+                  },
+                  "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use.
+                    "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice.
+                      "voiceName": "A String", # The name of the prebuilt voice to use.
+                    },
+                    "replicatedVoiceConfig": { # The configuration for the replicated voice to use. # Optional. The configuration for a replicated voice. This enables users to replicate a voice from an audio sample.
+                      "mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set.
+                      "voiceSampleAudio": "A String", # Optional. The sample of the custom voice.
+                    },
+                  },
+                },
+                "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker.
+                  "A String",
+                ],
+                "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0].
+                "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking.
+                  "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available.
+                  "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency.
+                  "thinkingLevel": "A String", # Optional. The number of thoughts tokens that the model should generate.
+                },
+                "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words.
+                "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both.
+              },
+              "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32.
+            },
+            "promptTemplate": "A String", # Template for the prompt used to generate rubrics. The details should be updated based on the most-recent recipe requirements.
+            "rubricContentType": "A String", # The type of rubric content to be generated.
+            "rubricTypeOntology": [ # Optional. An optional, pre-defined list of allowed types for generated rubrics. If this field is provided, it implies `include_rubric_type` should be true, and the generated rubric types should be chosen from this ontology.
+              "A String",
+            ],
+          },
+          "rubricGroupKey": "A String", # Use a pre-defined group of rubrics associated with the input. Refers to a key in the rubric_groups map of EvaluationInstance.
+          "systemInstruction": "A String", # Optional. System instructions for the judge model.
+        },
+        "metadata": { # Metadata about the metric, used for visualization and organization. # Optional. Metadata about the metric, used for visualization and organization.
+          "otherMetadata": { # Optional. Flexible metadata for user-defined attributes.
+            "a_key": "", # Properties of the object.
+          },
+          "scoreRange": { # The range of possible scores for this metric, used for plotting. # Optional. The range of possible scores for this metric, used for plotting.
+            "description": "A String", # Optional. The description of the score explaining the directionality etc.
+            "max": 3.14, # Required. The maximum value of the score range (inclusive).
+            "min": 3.14, # Required. The minimum value of the score range (inclusive).
+            "step": 3.14, # Optional. The distance between discrete steps in the range. If unset, the range is assumed to be continuous.
+          },
+          "title": "A String", # Optional. The user-friendly name for the metric. If not set for a registered metric, it will default to the metric's display name.
+        },
+        "pairwiseMetricSpec": { # Spec for pairwise metric. # Spec for pairwise metric.
+          "baselineResponseFieldName": "A String", # Optional. The field name of the baseline response.
+          "candidateResponseFieldName": "A String", # Optional. The field name of the candidate response.
+          "customOutputFormatConfig": { # Spec for custom output format configuration. # Optional. CustomOutputFormatConfig allows customization of metric output. When this config is set, the default output is replaced with the raw output string. If a custom format is chosen, the `pairwise_choice` and `explanation` fields in the corresponding metric result will be empty.
+            "returnRawOutput": True or False, # Optional. Whether to return raw output.
+          },
+          "metricPromptTemplate": "A String", # Required. Metric prompt template for pairwise metric.
+          "systemInstruction": "A String", # Optional. System instructions for pairwise metric.
+        },
+        "pointwiseMetricSpec": { # Spec for pointwise metric. # Spec for pointwise metric.
+          "customOutputFormatConfig": { # Spec for custom output format configuration. # Optional. CustomOutputFormatConfig allows customization of metric output. By default, metrics return a score and explanation. When this config is set, the default output is replaced with either: - The raw output string. - A parsed output based on a user-defined schema. If a custom format is chosen, the `score` and `explanation` fields in the corresponding metric result will be empty.
+            "returnRawOutput": True or False, # Optional. Whether to return raw output.
+          },
+          "metricPromptTemplate": "A String", # Required. Metric prompt template for pointwise metric.
+          "systemInstruction": "A String", # Optional. System instructions for pointwise metric.
+        },
+        "predefinedMetricSpec": { # The spec for a pre-defined metric. # The spec for a pre-defined metric.
+          "metricSpecName": "A String", # Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1".
+          "metricSpecParameters": { # Optional. The parameters needed to run the pre-defined metric.
+            "a_key": "", # Properties of the object.
+          },
+        },
+        "rougeSpec": { # Spec for rouge score metric - calculates the recall of n-grams in prediction as compared to reference - returns a score ranging between 0 and 1. # Spec for rouge metric.
+          "rougeType": "A String", # Optional. Supported rouge types are rougen[1-9], rougeL, and rougeLsum.
+          "splitSummaries": True or False, # Optional. Whether to split summaries while using rougeLsum.
+          "useStemmer": True or False, # Optional. Whether to use stemmer to compute rouge score.
+        },
+      },
+      "metricResourceName": "A String", # Resource name for registered metric.
+    },
+  ],
+  "name": "A String", # Identifier. The resource name of the OnlineEvaluator. Format: projects/{project}/locations/{location}/onlineEvaluators/{id}.
+  "state": "A String", # Output only. The state of the OnlineEvaluator.
+  "updateTime": "A String", # Output only. Timestamp when the OnlineEvaluator was last updated.
+}
+
+  updateMask: string, Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.
+  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, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ suspend(name, body=None, x__xgafv=None) +
Suspends an OnlineEvaluator. When an OnlineEvaluator is suspended, it won't run any evaluations until it is activated again.
+
+Args:
+  name: string, Required. The name of the OnlineEvaluator to suspend. Format: projects/{project}/locations/{location}/onlineEvaluators/{id}. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for SuspendOnlineEvaluator.
+}
+
+  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, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html b/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html index 407b836f29..5bd9c53a4a 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html @@ -108,7 +108,7 @@

Instance Methods

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

predict(endpoint, body=None, x__xgafv=None)

-

Perform an online prediction.

+

predictLongRunning(endpoint, body=None, x__xgafv=None)

@@ -1912,7 +1912,7 @@

Method Details

predict(endpoint, body=None, x__xgafv=None) -
Perform an online prediction.
+  
 
 Args:
   endpoint: string, Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` (required)
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.memories.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.memories.html
index 702bbe1182..8a6a1907c1 100644
--- a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.memories.html
+++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.memories.html
@@ -138,7 +138,7 @@ 

Method Details

"disableMemoryRevisions": True or False, # Optional. Input only. If true, no revision will be created for this request. "displayName": "A String", # Optional. Display name of the Memory. "expireTime": "A String", # Optional. Timestamp of when this resource is considered expired. This is *always* provided on output when `expiration` is set on input, regardless of whether `expire_time` or `ttl` was provided. - "fact": "A String", # Required. Semantic knowledge extracted from the source content. + "fact": "A String", # Optional. Semantic knowledge extracted from the source content. "metadata": { # Optional. User-provided metadata for the Memory. This information was provided when creating, updating, or generating the Memory. It was not generated by Memory Bank. "a_key": { # Memory metadata. "boolValue": True or False, # Boolean value. @@ -411,7 +411,7 @@

Method Details

"disableMemoryRevisions": True or False, # Optional. Input only. If true, no revision will be created for this request. "displayName": "A String", # Optional. Display name of the Memory. "expireTime": "A String", # Optional. Timestamp of when this resource is considered expired. This is *always* provided on output when `expiration` is set on input, regardless of whether `expire_time` or `ttl` was provided. - "fact": "A String", # Required. Semantic knowledge extracted from the source content. + "fact": "A String", # Optional. Semantic knowledge extracted from the source content. "metadata": { # Optional. User-provided metadata for the Memory. This information was provided when creating, updating, or generating the Memory. It was not generated by Memory Bank. "a_key": { # Memory metadata. "boolValue": True or False, # Boolean value. @@ -466,7 +466,7 @@

Method Details

"disableMemoryRevisions": True or False, # Optional. Input only. If true, no revision will be created for this request. "displayName": "A String", # Optional. Display name of the Memory. "expireTime": "A String", # Optional. Timestamp of when this resource is considered expired. This is *always* provided on output when `expiration` is set on input, regardless of whether `expire_time` or `ttl` was provided. - "fact": "A String", # Required. Semantic knowledge extracted from the source content. + "fact": "A String", # Optional. Semantic knowledge extracted from the source content. "metadata": { # Optional. User-provided metadata for the Memory. This information was provided when creating, updating, or generating the Memory. It was not generated by Memory Bank. "a_key": { # Memory metadata. "boolValue": True or False, # Boolean value. @@ -527,7 +527,7 @@

Method Details

"disableMemoryRevisions": True or False, # Optional. Input only. If true, no revision will be created for this request. "displayName": "A String", # Optional. Display name of the Memory. "expireTime": "A String", # Optional. Timestamp of when this resource is considered expired. This is *always* provided on output when `expiration` is set on input, regardless of whether `expire_time` or `ttl` was provided. - "fact": "A String", # Required. Semantic knowledge extracted from the source content. + "fact": "A String", # Optional. Semantic knowledge extracted from the source content. "metadata": { # Optional. User-provided metadata for the Memory. This information was provided when creating, updating, or generating the Memory. It was not generated by Memory Bank. "a_key": { # Memory metadata. "boolValue": True or False, # Boolean value. @@ -705,7 +705,7 @@

Method Details

"disableMemoryRevisions": True or False, # Optional. Input only. If true, no revision will be created for this request. "displayName": "A String", # Optional. Display name of the Memory. "expireTime": "A String", # Optional. Timestamp of when this resource is considered expired. This is *always* provided on output when `expiration` is set on input, regardless of whether `expire_time` or `ttl` was provided. - "fact": "A String", # Required. Semantic knowledge extracted from the source content. + "fact": "A String", # Optional. Semantic knowledge extracted from the source content. "metadata": { # Optional. User-provided metadata for the Memory. This information was provided when creating, updating, or generating the Memory. It was not generated by Memory Bank. "a_key": { # Memory metadata. "boolValue": True or False, # Boolean value. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.tuningJobs.html b/docs/dyn/aiplatform_v1beta1.projects.locations.tuningJobs.html index 402b1a71cc..61670413df 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.tuningJobs.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.tuningJobs.html @@ -157,6 +157,7 @@

Method Details

"learningRateMultiplier": 3.14, # Optional. Multiplier for adjusting the default learning rate. }, "pipelineRootDirectory": "A String", # Deprecated. A path in a Cloud Storage bucket, which will be treated as the root output directory of the distillation pipeline. It is used by the system to generate the paths of output artifacts. + "promptDatasetUri": "A String", # Optional. Cloud Storage path to file containing prompt dataset for distillation. The dataset must be formatted as a JSONL file. "studentModel": "A String", # The student model that is being tuned, e.g., "google/gemma-2b-1.1-it". Deprecated. Use base_model instead. "trainingDatasetUri": "A String", # Deprecated. Cloud Storage path to file containing training dataset for tuning. The dataset must be formatted as a JSONL file. "tunedTeacherModelSource": "A String", # The resource name of the Tuned teacher model. Format: `projects/{project}/locations/{location}/models/{model}`. @@ -1426,6 +1427,7 @@

Method Details

"hyperParameters": { # Hyperparameters for Veo. # Optional. Hyperparameters for Veo. "epochCount": "A String", # Optional. Number of complete passes the model makes over the entire training dataset during training. "learningRateMultiplier": 3.14, # Optional. Multiplier for adjusting the default learning rate. + "tuningSpeed": "A String", # Optional. The speed of the tuning job. Only supported for Veo 3.0 models. "tuningTask": "A String", # Optional. The tuning task. Either I2V or T2V. "veoDataMixtureRatio": 3.14, # Optional. The ratio of Google internal dataset to use in the training mixture, in range of `[0, 1)`. If `0.2`, it means 20% of Google internal dataset and 80% of user dataset will be used for training. If not set, the default value is 0.1. }, @@ -1457,6 +1459,7 @@

Method Details

"learningRateMultiplier": 3.14, # Optional. Multiplier for adjusting the default learning rate. }, "pipelineRootDirectory": "A String", # Deprecated. A path in a Cloud Storage bucket, which will be treated as the root output directory of the distillation pipeline. It is used by the system to generate the paths of output artifacts. + "promptDatasetUri": "A String", # Optional. Cloud Storage path to file containing prompt dataset for distillation. The dataset must be formatted as a JSONL file. "studentModel": "A String", # The student model that is being tuned, e.g., "google/gemma-2b-1.1-it". Deprecated. Use base_model instead. "trainingDatasetUri": "A String", # Deprecated. Cloud Storage path to file containing training dataset for tuning. The dataset must be formatted as a JSONL file. "tunedTeacherModelSource": "A String", # The resource name of the Tuned teacher model. Format: `projects/{project}/locations/{location}/models/{model}`. @@ -2726,6 +2729,7 @@

Method Details

"hyperParameters": { # Hyperparameters for Veo. # Optional. Hyperparameters for Veo. "epochCount": "A String", # Optional. Number of complete passes the model makes over the entire training dataset during training. "learningRateMultiplier": 3.14, # Optional. Multiplier for adjusting the default learning rate. + "tuningSpeed": "A String", # Optional. The speed of the tuning job. Only supported for Veo 3.0 models. "tuningTask": "A String", # Optional. The tuning task. Either I2V or T2V. "veoDataMixtureRatio": 3.14, # Optional. The ratio of Google internal dataset to use in the training mixture, in range of `[0, 1)`. If `0.2`, it means 20% of Google internal dataset and 80% of user dataset will be used for training. If not set, the default value is 0.1. }, @@ -2764,6 +2768,7 @@

Method Details

"learningRateMultiplier": 3.14, # Optional. Multiplier for adjusting the default learning rate. }, "pipelineRootDirectory": "A String", # Deprecated. A path in a Cloud Storage bucket, which will be treated as the root output directory of the distillation pipeline. It is used by the system to generate the paths of output artifacts. + "promptDatasetUri": "A String", # Optional. Cloud Storage path to file containing prompt dataset for distillation. The dataset must be formatted as a JSONL file. "studentModel": "A String", # The student model that is being tuned, e.g., "google/gemma-2b-1.1-it". Deprecated. Use base_model instead. "trainingDatasetUri": "A String", # Deprecated. Cloud Storage path to file containing training dataset for tuning. The dataset must be formatted as a JSONL file. "tunedTeacherModelSource": "A String", # The resource name of the Tuned teacher model. Format: `projects/{project}/locations/{location}/models/{model}`. @@ -4033,6 +4038,7 @@

Method Details

"hyperParameters": { # Hyperparameters for Veo. # Optional. Hyperparameters for Veo. "epochCount": "A String", # Optional. Number of complete passes the model makes over the entire training dataset during training. "learningRateMultiplier": 3.14, # Optional. Multiplier for adjusting the default learning rate. + "tuningSpeed": "A String", # Optional. The speed of the tuning job. Only supported for Veo 3.0 models. "tuningTask": "A String", # Optional. The tuning task. Either I2V or T2V. "veoDataMixtureRatio": 3.14, # Optional. The ratio of Google internal dataset to use in the training mixture, in range of `[0, 1)`. If `0.2`, it means 20% of Google internal dataset and 80% of user dataset will be used for training. If not set, the default value is 0.1. }, @@ -4077,6 +4083,7 @@

Method Details

"learningRateMultiplier": 3.14, # Optional. Multiplier for adjusting the default learning rate. }, "pipelineRootDirectory": "A String", # Deprecated. A path in a Cloud Storage bucket, which will be treated as the root output directory of the distillation pipeline. It is used by the system to generate the paths of output artifacts. + "promptDatasetUri": "A String", # Optional. Cloud Storage path to file containing prompt dataset for distillation. The dataset must be formatted as a JSONL file. "studentModel": "A String", # The student model that is being tuned, e.g., "google/gemma-2b-1.1-it". Deprecated. Use base_model instead. "trainingDatasetUri": "A String", # Deprecated. Cloud Storage path to file containing training dataset for tuning. The dataset must be formatted as a JSONL file. "tunedTeacherModelSource": "A String", # The resource name of the Tuned teacher model. Format: `projects/{project}/locations/{location}/models/{model}`. @@ -5346,6 +5353,7 @@

Method Details

"hyperParameters": { # Hyperparameters for Veo. # Optional. Hyperparameters for Veo. "epochCount": "A String", # Optional. Number of complete passes the model makes over the entire training dataset during training. "learningRateMultiplier": 3.14, # Optional. Multiplier for adjusting the default learning rate. + "tuningSpeed": "A String", # Optional. The speed of the tuning job. Only supported for Veo 3.0 models. "tuningTask": "A String", # Optional. The tuning task. Either I2V or T2V. "veoDataMixtureRatio": 3.14, # Optional. The ratio of Google internal dataset to use in the training mixture, in range of `[0, 1)`. If `0.2`, it means 20% of Google internal dataset and 80% of user dataset will be used for training. If not set, the default value is 0.1. }, @@ -5582,6 +5590,7 @@

Method Details

"learningRateMultiplier": 3.14, # Optional. Multiplier for adjusting the default learning rate. }, "pipelineRootDirectory": "A String", # Deprecated. A path in a Cloud Storage bucket, which will be treated as the root output directory of the distillation pipeline. It is used by the system to generate the paths of output artifacts. + "promptDatasetUri": "A String", # Optional. Cloud Storage path to file containing prompt dataset for distillation. The dataset must be formatted as a JSONL file. "studentModel": "A String", # The student model that is being tuned, e.g., "google/gemma-2b-1.1-it". Deprecated. Use base_model instead. "trainingDatasetUri": "A String", # Deprecated. Cloud Storage path to file containing training dataset for tuning. The dataset must be formatted as a JSONL file. "tunedTeacherModelSource": "A String", # The resource name of the Tuned teacher model. Format: `projects/{project}/locations/{location}/models/{model}`. @@ -6851,6 +6860,7 @@

Method Details

"hyperParameters": { # Hyperparameters for Veo. # Optional. Hyperparameters for Veo. "epochCount": "A String", # Optional. Number of complete passes the model makes over the entire training dataset during training. "learningRateMultiplier": 3.14, # Optional. Multiplier for adjusting the default learning rate. + "tuningSpeed": "A String", # Optional. The speed of the tuning job. Only supported for Veo 3.0 models. "tuningTask": "A String", # Optional. The tuning task. Either I2V or T2V. "veoDataMixtureRatio": 3.14, # Optional. The ratio of Google internal dataset to use in the training mixture, in range of `[0, 1)`. If `0.2`, it means 20% of Google internal dataset and 80% of user dataset will be used for training. If not set, the default value is 0.1. }, diff --git a/docs/dyn/aiplatform_v1beta1.publishers.models.html b/docs/dyn/aiplatform_v1beta1.publishers.models.html index 86f745c48f..03ec537fff 100644 --- a/docs/dyn/aiplatform_v1beta1.publishers.models.html +++ b/docs/dyn/aiplatform_v1beta1.publishers.models.html @@ -100,7 +100,7 @@

Instance Methods

Retrieves the next page of results.

predict(endpoint, body=None, x__xgafv=None)

-

Perform an online prediction.

+

predictLongRunning(endpoint, body=None, x__xgafv=None)

@@ -2876,7 +2876,7 @@

Method Details

predict(endpoint, body=None, x__xgafv=None) -
Perform an online prediction.
+  
 
 Args:
   endpoint: string, Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` (required)
diff --git a/docs/dyn/aiplatform_v1beta1.reasoningEngines.memories.html b/docs/dyn/aiplatform_v1beta1.reasoningEngines.memories.html
index 319ab63307..ab76865947 100644
--- a/docs/dyn/aiplatform_v1beta1.reasoningEngines.memories.html
+++ b/docs/dyn/aiplatform_v1beta1.reasoningEngines.memories.html
@@ -138,7 +138,7 @@ 

Method Details

"disableMemoryRevisions": True or False, # Optional. Input only. If true, no revision will be created for this request. "displayName": "A String", # Optional. Display name of the Memory. "expireTime": "A String", # Optional. Timestamp of when this resource is considered expired. This is *always* provided on output when `expiration` is set on input, regardless of whether `expire_time` or `ttl` was provided. - "fact": "A String", # Required. Semantic knowledge extracted from the source content. + "fact": "A String", # Optional. Semantic knowledge extracted from the source content. "metadata": { # Optional. User-provided metadata for the Memory. This information was provided when creating, updating, or generating the Memory. It was not generated by Memory Bank. "a_key": { # Memory metadata. "boolValue": True or False, # Boolean value. @@ -411,7 +411,7 @@

Method Details

"disableMemoryRevisions": True or False, # Optional. Input only. If true, no revision will be created for this request. "displayName": "A String", # Optional. Display name of the Memory. "expireTime": "A String", # Optional. Timestamp of when this resource is considered expired. This is *always* provided on output when `expiration` is set on input, regardless of whether `expire_time` or `ttl` was provided. - "fact": "A String", # Required. Semantic knowledge extracted from the source content. + "fact": "A String", # Optional. Semantic knowledge extracted from the source content. "metadata": { # Optional. User-provided metadata for the Memory. This information was provided when creating, updating, or generating the Memory. It was not generated by Memory Bank. "a_key": { # Memory metadata. "boolValue": True or False, # Boolean value. @@ -466,7 +466,7 @@

Method Details

"disableMemoryRevisions": True or False, # Optional. Input only. If true, no revision will be created for this request. "displayName": "A String", # Optional. Display name of the Memory. "expireTime": "A String", # Optional. Timestamp of when this resource is considered expired. This is *always* provided on output when `expiration` is set on input, regardless of whether `expire_time` or `ttl` was provided. - "fact": "A String", # Required. Semantic knowledge extracted from the source content. + "fact": "A String", # Optional. Semantic knowledge extracted from the source content. "metadata": { # Optional. User-provided metadata for the Memory. This information was provided when creating, updating, or generating the Memory. It was not generated by Memory Bank. "a_key": { # Memory metadata. "boolValue": True or False, # Boolean value. @@ -527,7 +527,7 @@

Method Details

"disableMemoryRevisions": True or False, # Optional. Input only. If true, no revision will be created for this request. "displayName": "A String", # Optional. Display name of the Memory. "expireTime": "A String", # Optional. Timestamp of when this resource is considered expired. This is *always* provided on output when `expiration` is set on input, regardless of whether `expire_time` or `ttl` was provided. - "fact": "A String", # Required. Semantic knowledge extracted from the source content. + "fact": "A String", # Optional. Semantic knowledge extracted from the source content. "metadata": { # Optional. User-provided metadata for the Memory. This information was provided when creating, updating, or generating the Memory. It was not generated by Memory Bank. "a_key": { # Memory metadata. "boolValue": True or False, # Boolean value. @@ -705,7 +705,7 @@

Method Details

"disableMemoryRevisions": True or False, # Optional. Input only. If true, no revision will be created for this request. "displayName": "A String", # Optional. Display name of the Memory. "expireTime": "A String", # Optional. Timestamp of when this resource is considered expired. This is *always* provided on output when `expiration` is set on input, regardless of whether `expire_time` or `ttl` was provided. - "fact": "A String", # Required. Semantic knowledge extracted from the source content. + "fact": "A String", # Optional. Semantic knowledge extracted from the source content. "metadata": { # Optional. User-provided metadata for the Memory. This information was provided when creating, updating, or generating the Memory. It was not generated by Memory Bank. "a_key": { # Memory metadata. "boolValue": True or False, # Boolean value. diff --git a/docs/dyn/alloydb_v1.projects.locations.clusters.instances.html b/docs/dyn/alloydb_v1.projects.locations.clusters.instances.html index 6d2d00b7a7..d04519e512 100644 --- a/docs/dyn/alloydb_v1.projects.locations.clusters.instances.html +++ b/docs/dyn/alloydb_v1.projects.locations.clusters.instances.html @@ -180,6 +180,7 @@

Method Details

{ # Details of a single node in the instance. Nodes in an AlloyDB instance are ephemeral, they can change during update, failover, autohealing and resize operations. "id": "A String", # Output only. The identifier of the VM e.g. "test-read-0601-407e52be-ms3l". "ip": "A String", # Output only. The private IP address of the VM e.g. "10.57.0.34". + "isHotStandby": True or False, # Output only. Indicates whether the node set up to be configured as a hot standby. "state": "A String", # Output only. Determined by state of the compute VM and postgres-service health. Compute VM state can have values listed in https://cloud.google.com/compute/docs/instances/instance-life-cycle and postgres-service health can have values: HEALTHY and UNHEALTHY. "zoneId": "A String", # Output only. The Compute Engine zone of the VM e.g. "us-central1-b". }, @@ -236,6 +237,7 @@

Method Details

"writableNode": { # Details of a single node in the instance. Nodes in an AlloyDB instance are ephemeral, they can change during update, failover, autohealing and resize operations. # Output only. This is set for the read-write VM of the PRIMARY instance only. "id": "A String", # Output only. The identifier of the VM e.g. "test-read-0601-407e52be-ms3l". "ip": "A String", # Output only. The private IP address of the VM e.g. "10.57.0.34". + "isHotStandby": True or False, # Output only. Indicates whether the node set up to be configured as a hot standby. "state": "A String", # Output only. Determined by state of the compute VM and postgres-service health. Compute VM state can have values listed in https://cloud.google.com/compute/docs/instances/instance-life-cycle and postgres-service health can have values: HEALTHY and UNHEALTHY. "zoneId": "A String", # Output only. The Compute Engine zone of the VM e.g. "us-central1-b". }, @@ -337,6 +339,7 @@

Method Details

{ # Details of a single node in the instance. Nodes in an AlloyDB instance are ephemeral, they can change during update, failover, autohealing and resize operations. "id": "A String", # Output only. The identifier of the VM e.g. "test-read-0601-407e52be-ms3l". "ip": "A String", # Output only. The private IP address of the VM e.g. "10.57.0.34". + "isHotStandby": True or False, # Output only. Indicates whether the node set up to be configured as a hot standby. "state": "A String", # Output only. Determined by state of the compute VM and postgres-service health. Compute VM state can have values listed in https://cloud.google.com/compute/docs/instances/instance-life-cycle and postgres-service health can have values: HEALTHY and UNHEALTHY. "zoneId": "A String", # Output only. The Compute Engine zone of the VM e.g. "us-central1-b". }, @@ -393,6 +396,7 @@

Method Details

"writableNode": { # Details of a single node in the instance. Nodes in an AlloyDB instance are ephemeral, they can change during update, failover, autohealing and resize operations. # Output only. This is set for the read-write VM of the PRIMARY instance only. "id": "A String", # Output only. The identifier of the VM e.g. "test-read-0601-407e52be-ms3l". "ip": "A String", # Output only. The private IP address of the VM e.g. "10.57.0.34". + "isHotStandby": True or False, # Output only. Indicates whether the node set up to be configured as a hot standby. "state": "A String", # Output only. Determined by state of the compute VM and postgres-service health. Compute VM state can have values listed in https://cloud.google.com/compute/docs/instances/instance-life-cycle and postgres-service health can have values: HEALTHY and UNHEALTHY. "zoneId": "A String", # Output only. The Compute Engine zone of the VM e.g. "us-central1-b". }, @@ -585,6 +589,7 @@

Method Details

{ # Details of a single node in the instance. Nodes in an AlloyDB instance are ephemeral, they can change during update, failover, autohealing and resize operations. "id": "A String", # Output only. The identifier of the VM e.g. "test-read-0601-407e52be-ms3l". "ip": "A String", # Output only. The private IP address of the VM e.g. "10.57.0.34". + "isHotStandby": True or False, # Output only. Indicates whether the node set up to be configured as a hot standby. "state": "A String", # Output only. Determined by state of the compute VM and postgres-service health. Compute VM state can have values listed in https://cloud.google.com/compute/docs/instances/instance-life-cycle and postgres-service health can have values: HEALTHY and UNHEALTHY. "zoneId": "A String", # Output only. The Compute Engine zone of the VM e.g. "us-central1-b". }, @@ -641,6 +646,7 @@

Method Details

"writableNode": { # Details of a single node in the instance. Nodes in an AlloyDB instance are ephemeral, they can change during update, failover, autohealing and resize operations. # Output only. This is set for the read-write VM of the PRIMARY instance only. "id": "A String", # Output only. The identifier of the VM e.g. "test-read-0601-407e52be-ms3l". "ip": "A String", # Output only. The private IP address of the VM e.g. "10.57.0.34". + "isHotStandby": True or False, # Output only. Indicates whether the node set up to be configured as a hot standby. "state": "A String", # Output only. Determined by state of the compute VM and postgres-service health. Compute VM state can have values listed in https://cloud.google.com/compute/docs/instances/instance-life-cycle and postgres-service health can have values: HEALTHY and UNHEALTHY. "zoneId": "A String", # Output only. The Compute Engine zone of the VM e.g. "us-central1-b". }, @@ -789,6 +795,7 @@

Method Details

{ # Details of a single node in the instance. Nodes in an AlloyDB instance are ephemeral, they can change during update, failover, autohealing and resize operations. "id": "A String", # Output only. The identifier of the VM e.g. "test-read-0601-407e52be-ms3l". "ip": "A String", # Output only. The private IP address of the VM e.g. "10.57.0.34". + "isHotStandby": True or False, # Output only. Indicates whether the node set up to be configured as a hot standby. "state": "A String", # Output only. Determined by state of the compute VM and postgres-service health. Compute VM state can have values listed in https://cloud.google.com/compute/docs/instances/instance-life-cycle and postgres-service health can have values: HEALTHY and UNHEALTHY. "zoneId": "A String", # Output only. The Compute Engine zone of the VM e.g. "us-central1-b". }, @@ -845,6 +852,7 @@

Method Details

"writableNode": { # Details of a single node in the instance. Nodes in an AlloyDB instance are ephemeral, they can change during update, failover, autohealing and resize operations. # Output only. This is set for the read-write VM of the PRIMARY instance only. "id": "A String", # Output only. The identifier of the VM e.g. "test-read-0601-407e52be-ms3l". "ip": "A String", # Output only. The private IP address of the VM e.g. "10.57.0.34". + "isHotStandby": True or False, # Output only. Indicates whether the node set up to be configured as a hot standby. "state": "A String", # Output only. Determined by state of the compute VM and postgres-service health. Compute VM state can have values listed in https://cloud.google.com/compute/docs/instances/instance-life-cycle and postgres-service health can have values: HEALTHY and UNHEALTHY. "zoneId": "A String", # Output only. The Compute Engine zone of the VM e.g. "us-central1-b". }, @@ -935,6 +943,7 @@

Method Details

{ # Details of a single node in the instance. Nodes in an AlloyDB instance are ephemeral, they can change during update, failover, autohealing and resize operations. "id": "A String", # Output only. The identifier of the VM e.g. "test-read-0601-407e52be-ms3l". "ip": "A String", # Output only. The private IP address of the VM e.g. "10.57.0.34". + "isHotStandby": True or False, # Output only. Indicates whether the node set up to be configured as a hot standby. "state": "A String", # Output only. Determined by state of the compute VM and postgres-service health. Compute VM state can have values listed in https://cloud.google.com/compute/docs/instances/instance-life-cycle and postgres-service health can have values: HEALTHY and UNHEALTHY. "zoneId": "A String", # Output only. The Compute Engine zone of the VM e.g. "us-central1-b". }, @@ -991,6 +1000,7 @@

Method Details

"writableNode": { # Details of a single node in the instance. Nodes in an AlloyDB instance are ephemeral, they can change during update, failover, autohealing and resize operations. # Output only. This is set for the read-write VM of the PRIMARY instance only. "id": "A String", # Output only. The identifier of the VM e.g. "test-read-0601-407e52be-ms3l". "ip": "A String", # Output only. The private IP address of the VM e.g. "10.57.0.34". + "isHotStandby": True or False, # Output only. Indicates whether the node set up to be configured as a hot standby. "state": "A String", # Output only. Determined by state of the compute VM and postgres-service health. Compute VM state can have values listed in https://cloud.google.com/compute/docs/instances/instance-life-cycle and postgres-service health can have values: HEALTHY and UNHEALTHY. "zoneId": "A String", # Output only. The Compute Engine zone of the VM e.g. "us-central1-b". }, diff --git a/docs/dyn/alloydb_v1.projects.locations.html b/docs/dyn/alloydb_v1.projects.locations.html index 4f84fe16aa..81cd97055e 100644 --- a/docs/dyn/alloydb_v1.projects.locations.html +++ b/docs/dyn/alloydb_v1.projects.locations.html @@ -102,7 +102,7 @@

Instance Methods

Gets information about a location.

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

-

Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.

+

Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.

list_next()

Retrieves the next page of results.

@@ -141,7 +141,7 @@

Method Details

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
+  
Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
diff --git a/docs/dyn/alloydb_v1alpha.projects.locations.clusters.html b/docs/dyn/alloydb_v1alpha.projects.locations.clusters.html
index 1bf7d06d4e..ef68057d50 100644
--- a/docs/dyn/alloydb_v1alpha.projects.locations.clusters.html
+++ b/docs/dyn/alloydb_v1alpha.projects.locations.clusters.html
@@ -1499,6 +1499,7 @@ 

Method Details

{ # Message for promoting a Cluster "etag": "A String", # Optional. The current etag of the Cluster. If an etag is provided and does not match the current etag of the Cluster, deletion will be blocked and an ABORTED error will be returned. + "failover": True or False, # Optional. If set, the promote operation will attempt to recreate the original primary cluster as a secondary cluster when it comes back online. Otherwise, the promoted cluster will be a standalone cluster. Currently only supported when there is a single secondary cluster. "requestId": "A String", # Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). "validateOnly": True or False, # Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request. } diff --git a/docs/dyn/alloydb_v1alpha.projects.locations.clusters.instances.html b/docs/dyn/alloydb_v1alpha.projects.locations.clusters.instances.html index 5441308319..9d1522609b 100644 --- a/docs/dyn/alloydb_v1alpha.projects.locations.clusters.instances.html +++ b/docs/dyn/alloydb_v1alpha.projects.locations.clusters.instances.html @@ -186,6 +186,7 @@

Method Details

{ # Details of a single node in the instance. Nodes in an AlloyDB instance are ephemeral, they can change during update, failover, autohealing and resize operations. "id": "A String", # Output only. The identifier of the VM e.g. "test-read-0601-407e52be-ms3l". "ip": "A String", # Output only. The private IP address of the VM e.g. "10.57.0.34". + "isHotStandby": True or False, # Output only. Indicates whether the node set up to be configured as a hot standby. "state": "A String", # Output only. Determined by state of the compute VM and postgres-service health. Compute VM state can have values listed in https://cloud.google.com/compute/docs/instances/instance-life-cycle and postgres-service health can have values: HEALTHY and UNHEALTHY. "zoneId": "A String", # Output only. The Compute Engine zone of the VM e.g. "us-central1-b". }, @@ -270,6 +271,7 @@

Method Details

"writableNode": { # Details of a single node in the instance. Nodes in an AlloyDB instance are ephemeral, they can change during update, failover, autohealing and resize operations. # Output only. This is set for the read-write VM of the PRIMARY instance only. "id": "A String", # Output only. The identifier of the VM e.g. "test-read-0601-407e52be-ms3l". "ip": "A String", # Output only. The private IP address of the VM e.g. "10.57.0.34". + "isHotStandby": True or False, # Output only. Indicates whether the node set up to be configured as a hot standby. "state": "A String", # Output only. Determined by state of the compute VM and postgres-service health. Compute VM state can have values listed in https://cloud.google.com/compute/docs/instances/instance-life-cycle and postgres-service health can have values: HEALTHY and UNHEALTHY. "zoneId": "A String", # Output only. The Compute Engine zone of the VM e.g. "us-central1-b". }, @@ -377,6 +379,7 @@

Method Details

{ # Details of a single node in the instance. Nodes in an AlloyDB instance are ephemeral, they can change during update, failover, autohealing and resize operations. "id": "A String", # Output only. The identifier of the VM e.g. "test-read-0601-407e52be-ms3l". "ip": "A String", # Output only. The private IP address of the VM e.g. "10.57.0.34". + "isHotStandby": True or False, # Output only. Indicates whether the node set up to be configured as a hot standby. "state": "A String", # Output only. Determined by state of the compute VM and postgres-service health. Compute VM state can have values listed in https://cloud.google.com/compute/docs/instances/instance-life-cycle and postgres-service health can have values: HEALTHY and UNHEALTHY. "zoneId": "A String", # Output only. The Compute Engine zone of the VM e.g. "us-central1-b". }, @@ -461,6 +464,7 @@

Method Details

"writableNode": { # Details of a single node in the instance. Nodes in an AlloyDB instance are ephemeral, they can change during update, failover, autohealing and resize operations. # Output only. This is set for the read-write VM of the PRIMARY instance only. "id": "A String", # Output only. The identifier of the VM e.g. "test-read-0601-407e52be-ms3l". "ip": "A String", # Output only. The private IP address of the VM e.g. "10.57.0.34". + "isHotStandby": True or False, # Output only. Indicates whether the node set up to be configured as a hot standby. "state": "A String", # Output only. Determined by state of the compute VM and postgres-service health. Compute VM state can have values listed in https://cloud.google.com/compute/docs/instances/instance-life-cycle and postgres-service health can have values: HEALTHY and UNHEALTHY. "zoneId": "A String", # Output only. The Compute Engine zone of the VM e.g. "us-central1-b". }, @@ -659,6 +663,7 @@

Method Details

{ # Details of a single node in the instance. Nodes in an AlloyDB instance are ephemeral, they can change during update, failover, autohealing and resize operations. "id": "A String", # Output only. The identifier of the VM e.g. "test-read-0601-407e52be-ms3l". "ip": "A String", # Output only. The private IP address of the VM e.g. "10.57.0.34". + "isHotStandby": True or False, # Output only. Indicates whether the node set up to be configured as a hot standby. "state": "A String", # Output only. Determined by state of the compute VM and postgres-service health. Compute VM state can have values listed in https://cloud.google.com/compute/docs/instances/instance-life-cycle and postgres-service health can have values: HEALTHY and UNHEALTHY. "zoneId": "A String", # Output only. The Compute Engine zone of the VM e.g. "us-central1-b". }, @@ -743,6 +748,7 @@

Method Details

"writableNode": { # Details of a single node in the instance. Nodes in an AlloyDB instance are ephemeral, they can change during update, failover, autohealing and resize operations. # Output only. This is set for the read-write VM of the PRIMARY instance only. "id": "A String", # Output only. The identifier of the VM e.g. "test-read-0601-407e52be-ms3l". "ip": "A String", # Output only. The private IP address of the VM e.g. "10.57.0.34". + "isHotStandby": True or False, # Output only. Indicates whether the node set up to be configured as a hot standby. "state": "A String", # Output only. Determined by state of the compute VM and postgres-service health. Compute VM state can have values listed in https://cloud.google.com/compute/docs/instances/instance-life-cycle and postgres-service health can have values: HEALTHY and UNHEALTHY. "zoneId": "A String", # Output only. The Compute Engine zone of the VM e.g. "us-central1-b". }, @@ -901,6 +907,7 @@

Method Details

{ # Details of a single node in the instance. Nodes in an AlloyDB instance are ephemeral, they can change during update, failover, autohealing and resize operations. "id": "A String", # Output only. The identifier of the VM e.g. "test-read-0601-407e52be-ms3l". "ip": "A String", # Output only. The private IP address of the VM e.g. "10.57.0.34". + "isHotStandby": True or False, # Output only. Indicates whether the node set up to be configured as a hot standby. "state": "A String", # Output only. Determined by state of the compute VM and postgres-service health. Compute VM state can have values listed in https://cloud.google.com/compute/docs/instances/instance-life-cycle and postgres-service health can have values: HEALTHY and UNHEALTHY. "zoneId": "A String", # Output only. The Compute Engine zone of the VM e.g. "us-central1-b". }, @@ -985,6 +992,7 @@

Method Details

"writableNode": { # Details of a single node in the instance. Nodes in an AlloyDB instance are ephemeral, they can change during update, failover, autohealing and resize operations. # Output only. This is set for the read-write VM of the PRIMARY instance only. "id": "A String", # Output only. The identifier of the VM e.g. "test-read-0601-407e52be-ms3l". "ip": "A String", # Output only. The private IP address of the VM e.g. "10.57.0.34". + "isHotStandby": True or False, # Output only. Indicates whether the node set up to be configured as a hot standby. "state": "A String", # Output only. Determined by state of the compute VM and postgres-service health. Compute VM state can have values listed in https://cloud.google.com/compute/docs/instances/instance-life-cycle and postgres-service health can have values: HEALTHY and UNHEALTHY. "zoneId": "A String", # Output only. The Compute Engine zone of the VM e.g. "us-central1-b". }, @@ -1081,6 +1089,7 @@

Method Details

{ # Details of a single node in the instance. Nodes in an AlloyDB instance are ephemeral, they can change during update, failover, autohealing and resize operations. "id": "A String", # Output only. The identifier of the VM e.g. "test-read-0601-407e52be-ms3l". "ip": "A String", # Output only. The private IP address of the VM e.g. "10.57.0.34". + "isHotStandby": True or False, # Output only. Indicates whether the node set up to be configured as a hot standby. "state": "A String", # Output only. Determined by state of the compute VM and postgres-service health. Compute VM state can have values listed in https://cloud.google.com/compute/docs/instances/instance-life-cycle and postgres-service health can have values: HEALTHY and UNHEALTHY. "zoneId": "A String", # Output only. The Compute Engine zone of the VM e.g. "us-central1-b". }, @@ -1165,6 +1174,7 @@

Method Details

"writableNode": { # Details of a single node in the instance. Nodes in an AlloyDB instance are ephemeral, they can change during update, failover, autohealing and resize operations. # Output only. This is set for the read-write VM of the PRIMARY instance only. "id": "A String", # Output only. The identifier of the VM e.g. "test-read-0601-407e52be-ms3l". "ip": "A String", # Output only. The private IP address of the VM e.g. "10.57.0.34". + "isHotStandby": True or False, # Output only. Indicates whether the node set up to be configured as a hot standby. "state": "A String", # Output only. Determined by state of the compute VM and postgres-service health. Compute VM state can have values listed in https://cloud.google.com/compute/docs/instances/instance-life-cycle and postgres-service health can have values: HEALTHY and UNHEALTHY. "zoneId": "A String", # Output only. The Compute Engine zone of the VM e.g. "us-central1-b". }, diff --git a/docs/dyn/alloydb_v1alpha.projects.locations.endpoints.html b/docs/dyn/alloydb_v1alpha.projects.locations.endpoints.html new file mode 100644 index 0000000000..87d167c4fe --- /dev/null +++ b/docs/dyn/alloydb_v1alpha.projects.locations.endpoints.html @@ -0,0 +1,385 @@ + + + +

AlloyDB API . projects . locations . endpoints

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ create(parent, body=None, endpointId=None, requestId=None, validateOnly=None, x__xgafv=None)

+

Creates a new Endpoint in a given project and location.

+

+ delete(name, etag=None, requestId=None, validateOnly=None, x__xgafv=None)

+

Deletes a single Endpoint.

+

+ get(name, x__xgafv=None)

+

Gets details of a single Endpoint.

+

+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists Endpoints in a given project and location.

+

+ list_next()

+

Retrieves the next page of results.

+

+ patch(name, allowMissing=None, body=None, requestId=None, updateMask=None, validateOnly=None, x__xgafv=None)

+

Updates the parameters of a single Endpoint.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, endpointId=None, requestId=None, validateOnly=None, x__xgafv=None) +
Creates a new Endpoint in a given project and location.
+
+Args:
+  parent: string, Required. The location of the new endpoint. For the required format, see the comment on the Endpoint.name field. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Endpoint resource.
+  "annotations": { # Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128
+    "a_key": "A String",
+  },
+  "createTime": "A String", # Output only. Create time stamp
+  "deleteTime": "A String", # Output only. Delete time stamp
+  "displayName": "A String", # User-settable and human-readable display name for the Endpoint.
+  "dnsConfig": { # The DNS config for the endpoint, containing the DNS record name, type and targets. # Output only. The DNS config for the endpoint. Each endpoint is associated with a specific DNS name and the DNS type. The DNS targets are the IP addresses of the target instances. The dns_type is the type of the DNS record, eg. Type "A" or Type "CNAME". This field is not configurable by the user, and it is updated when user specifies the target instances.
+    "dnsName": "A String", # The fully qualified domain name (FQDN) of the DNS record, e.g., ".location.alloydb-psa.goog".
+    "dnsRecordType": "A String", # The type of the DNS record, e.g., "A", "AAAA", "CNAME".
+  },
+  "effectiveTargetInstances": [ # Output only. The effective target instances that the endpoint is associated with. This is a list of target instance names, e.g. projects/{project_number}/locations/{location}/clusters/{cluster_id}/instances/{instance_id} For write endpoint, there is only one effective target instance which has to be a primary instance. Effective target instances are only different from target instances after a switchover or cross-region failover operation. Otherwise, effective_target_instances are the same as target_instances. Note that after a cross-region failover operation, the effective_target_instances can be stale until the operation to update the endpoint is complete.
+    "A String",
+  ],
+  "endpointType": "A String", # The type of the endpoint, either write or read.
+  "etag": "A String", # For Resource freshness validation (https://google.aip.dev/154)
+  "name": "A String", # Output only. Identifier. The name of the endpoint resource with the format: * projects/{project}/locations/{region}/endpoints/{endpoint_id} where the endpoint ID segment should satisfy the regex expression `[a-z0-9-]+`. For more details see https://google.aip.dev/122. The prefix of the endpoint resource name is the name of the parent resource: * projects/{project}/locations/{region}
+  "reconciling": True or False, # Output only. Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of Endpoint does not match the user's intended state, and the service is actively updating the Endpoint to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance.
+  "state": "A String", # Output only. The state of the endpoint.
+  "targetInstances": [ # The names of the target instances for the endpoint, should be of format projects/{project}/locations/{region}/clusters/{cluster}/instances/{instance}. For write endpoint, there is only one target instance which has to be a primary instance. For read endpoint, there can be multiple target instances which can be read or secondary instances. After a cross-region failover or switchover operation, the endpoint will be associated with a different target instance. This change will be reflected in the effective_target_instances field.
+    "A String",
+  ],
+  "uid": "A String", # Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.
+  "updateTime": "A String", # Output only. Update time stamp
+}
+
+  endpointId: string, Required. ID of the requesting object.
+  requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+  validateOnly: boolean, Optional. If set, the backend validates the request, but doesn't actually execute it.
+  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, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ delete(name, etag=None, requestId=None, validateOnly=None, x__xgafv=None) +
Deletes a single Endpoint.
+
+Args:
+  name: string, Required. The name of the resource. For the required format, see the comment on the Endpoint.name field. (required)
+  etag: string, Optional. The current etag of the Endpoint. If an etag is provided and does not match the current etag of the Endpoint, deletion will be blocked and an ABORTED error will be returned.
+  requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+  validateOnly: boolean, Optional. If set, the backend validates the request, but doesn't actually execute it.
+  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, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ get(name, x__xgafv=None) +
Gets details of a single Endpoint.
+
+Args:
+  name: string, Required. The name of the resource. For the required format, see the comment on the Endpoint.name field. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Endpoint resource.
+  "annotations": { # Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128
+    "a_key": "A String",
+  },
+  "createTime": "A String", # Output only. Create time stamp
+  "deleteTime": "A String", # Output only. Delete time stamp
+  "displayName": "A String", # User-settable and human-readable display name for the Endpoint.
+  "dnsConfig": { # The DNS config for the endpoint, containing the DNS record name, type and targets. # Output only. The DNS config for the endpoint. Each endpoint is associated with a specific DNS name and the DNS type. The DNS targets are the IP addresses of the target instances. The dns_type is the type of the DNS record, eg. Type "A" or Type "CNAME". This field is not configurable by the user, and it is updated when user specifies the target instances.
+    "dnsName": "A String", # The fully qualified domain name (FQDN) of the DNS record, e.g., ".location.alloydb-psa.goog".
+    "dnsRecordType": "A String", # The type of the DNS record, e.g., "A", "AAAA", "CNAME".
+  },
+  "effectiveTargetInstances": [ # Output only. The effective target instances that the endpoint is associated with. This is a list of target instance names, e.g. projects/{project_number}/locations/{location}/clusters/{cluster_id}/instances/{instance_id} For write endpoint, there is only one effective target instance which has to be a primary instance. Effective target instances are only different from target instances after a switchover or cross-region failover operation. Otherwise, effective_target_instances are the same as target_instances. Note that after a cross-region failover operation, the effective_target_instances can be stale until the operation to update the endpoint is complete.
+    "A String",
+  ],
+  "endpointType": "A String", # The type of the endpoint, either write or read.
+  "etag": "A String", # For Resource freshness validation (https://google.aip.dev/154)
+  "name": "A String", # Output only. Identifier. The name of the endpoint resource with the format: * projects/{project}/locations/{region}/endpoints/{endpoint_id} where the endpoint ID segment should satisfy the regex expression `[a-z0-9-]+`. For more details see https://google.aip.dev/122. The prefix of the endpoint resource name is the name of the parent resource: * projects/{project}/locations/{region}
+  "reconciling": True or False, # Output only. Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of Endpoint does not match the user's intended state, and the service is actively updating the Endpoint to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance.
+  "state": "A String", # Output only. The state of the endpoint.
+  "targetInstances": [ # The names of the target instances for the endpoint, should be of format projects/{project}/locations/{region}/clusters/{cluster}/instances/{instance}. For write endpoint, there is only one target instance which has to be a primary instance. For read endpoint, there can be multiple target instances which can be read or secondary instances. After a cross-region failover or switchover operation, the endpoint will be associated with a different target instance. This change will be reflected in the effective_target_instances field.
+    "A String",
+  ],
+  "uid": "A String", # Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.
+  "updateTime": "A String", # Output only. Update time stamp
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists Endpoints in a given project and location.
+
+Args:
+  parent: string, Required. The name of the parent resource. For the required format, see the comment on the Endpoint.name field. Additionally, you can perform an aggregated list operation by specifying a value with the following format: * projects/{project}/locations/- (required)
+  filter: string, Optional. Filtering results. This field is currently not supported, its value will be ignored if passed.
+  orderBy: string, Optional. Hint for how to order the results
+  pageSize: integer, Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
+  pageToken: string, Optional. A page token, received from a previous `ListEndpoints` call. This should be provided to retrieve the subsequent page. This field is currently not supported, its value will be ignored if passed.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message for response to listing Endpoints
+  "endpoints": [ # The list of Endpoints
+    { # Endpoint resource.
+      "annotations": { # Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128
+        "a_key": "A String",
+      },
+      "createTime": "A String", # Output only. Create time stamp
+      "deleteTime": "A String", # Output only. Delete time stamp
+      "displayName": "A String", # User-settable and human-readable display name for the Endpoint.
+      "dnsConfig": { # The DNS config for the endpoint, containing the DNS record name, type and targets. # Output only. The DNS config for the endpoint. Each endpoint is associated with a specific DNS name and the DNS type. The DNS targets are the IP addresses of the target instances. The dns_type is the type of the DNS record, eg. Type "A" or Type "CNAME". This field is not configurable by the user, and it is updated when user specifies the target instances.
+        "dnsName": "A String", # The fully qualified domain name (FQDN) of the DNS record, e.g., ".location.alloydb-psa.goog".
+        "dnsRecordType": "A String", # The type of the DNS record, e.g., "A", "AAAA", "CNAME".
+      },
+      "effectiveTargetInstances": [ # Output only. The effective target instances that the endpoint is associated with. This is a list of target instance names, e.g. projects/{project_number}/locations/{location}/clusters/{cluster_id}/instances/{instance_id} For write endpoint, there is only one effective target instance which has to be a primary instance. Effective target instances are only different from target instances after a switchover or cross-region failover operation. Otherwise, effective_target_instances are the same as target_instances. Note that after a cross-region failover operation, the effective_target_instances can be stale until the operation to update the endpoint is complete.
+        "A String",
+      ],
+      "endpointType": "A String", # The type of the endpoint, either write or read.
+      "etag": "A String", # For Resource freshness validation (https://google.aip.dev/154)
+      "name": "A String", # Output only. Identifier. The name of the endpoint resource with the format: * projects/{project}/locations/{region}/endpoints/{endpoint_id} where the endpoint ID segment should satisfy the regex expression `[a-z0-9-]+`. For more details see https://google.aip.dev/122. The prefix of the endpoint resource name is the name of the parent resource: * projects/{project}/locations/{region}
+      "reconciling": True or False, # Output only. Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of Endpoint does not match the user's intended state, and the service is actively updating the Endpoint to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance.
+      "state": "A String", # Output only. The state of the endpoint.
+      "targetInstances": [ # The names of the target instances for the endpoint, should be of format projects/{project}/locations/{region}/clusters/{cluster}/instances/{instance}. For write endpoint, there is only one target instance which has to be a primary instance. For read endpoint, there can be multiple target instances which can be read or secondary instances. After a cross-region failover or switchover operation, the endpoint will be associated with a different target instance. This change will be reflected in the effective_target_instances field.
+        "A String",
+      ],
+      "uid": "A String", # Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.
+      "updateTime": "A String", # Output only. Update time stamp
+    },
+  ],
+  "nextPageToken": "A String", # A token identifying a page of results the server should return.
+  "unreachable": [ # Locations that could not be reached.
+    "A String",
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(name, allowMissing=None, body=None, requestId=None, updateMask=None, validateOnly=None, x__xgafv=None) +
Updates the parameters of a single Endpoint.
+
+Args:
+  name: string, Output only. Identifier. The name of the endpoint resource with the format: * projects/{project}/locations/{region}/endpoints/{endpoint_id} where the endpoint ID segment should satisfy the regex expression `[a-z0-9-]+`. For more details see https://google.aip.dev/122. The prefix of the endpoint resource name is the name of the parent resource: * projects/{project}/locations/{region} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Endpoint resource.
+  "annotations": { # Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128
+    "a_key": "A String",
+  },
+  "createTime": "A String", # Output only. Create time stamp
+  "deleteTime": "A String", # Output only. Delete time stamp
+  "displayName": "A String", # User-settable and human-readable display name for the Endpoint.
+  "dnsConfig": { # The DNS config for the endpoint, containing the DNS record name, type and targets. # Output only. The DNS config for the endpoint. Each endpoint is associated with a specific DNS name and the DNS type. The DNS targets are the IP addresses of the target instances. The dns_type is the type of the DNS record, eg. Type "A" or Type "CNAME". This field is not configurable by the user, and it is updated when user specifies the target instances.
+    "dnsName": "A String", # The fully qualified domain name (FQDN) of the DNS record, e.g., ".location.alloydb-psa.goog".
+    "dnsRecordType": "A String", # The type of the DNS record, e.g., "A", "AAAA", "CNAME".
+  },
+  "effectiveTargetInstances": [ # Output only. The effective target instances that the endpoint is associated with. This is a list of target instance names, e.g. projects/{project_number}/locations/{location}/clusters/{cluster_id}/instances/{instance_id} For write endpoint, there is only one effective target instance which has to be a primary instance. Effective target instances are only different from target instances after a switchover or cross-region failover operation. Otherwise, effective_target_instances are the same as target_instances. Note that after a cross-region failover operation, the effective_target_instances can be stale until the operation to update the endpoint is complete.
+    "A String",
+  ],
+  "endpointType": "A String", # The type of the endpoint, either write or read.
+  "etag": "A String", # For Resource freshness validation (https://google.aip.dev/154)
+  "name": "A String", # Output only. Identifier. The name of the endpoint resource with the format: * projects/{project}/locations/{region}/endpoints/{endpoint_id} where the endpoint ID segment should satisfy the regex expression `[a-z0-9-]+`. For more details see https://google.aip.dev/122. The prefix of the endpoint resource name is the name of the parent resource: * projects/{project}/locations/{region}
+  "reconciling": True or False, # Output only. Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of Endpoint does not match the user's intended state, and the service is actively updating the Endpoint to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance.
+  "state": "A String", # Output only. The state of the endpoint.
+  "targetInstances": [ # The names of the target instances for the endpoint, should be of format projects/{project}/locations/{region}/clusters/{cluster}/instances/{instance}. For write endpoint, there is only one target instance which has to be a primary instance. For read endpoint, there can be multiple target instances which can be read or secondary instances. After a cross-region failover or switchover operation, the endpoint will be associated with a different target instance. This change will be reflected in the effective_target_instances field.
+    "A String",
+  ],
+  "uid": "A String", # Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.
+  "updateTime": "A String", # Output only. Update time stamp
+}
+
+  allowMissing: boolean, Optional. If set to true, update succeeds even if endpoint is not found. In that case, a new endpoint is created and `update_mask` is ignored.
+  requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+  updateMask: string, Optional. Field mask is used to specify the fields to be overwritten in the Endpoint resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
+  validateOnly: boolean, Optional. If set, the backend validates the request, but doesn't actually execute it.
+  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, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/alloydb_v1alpha.projects.locations.html b/docs/dyn/alloydb_v1alpha.projects.locations.html index f85aebbbac..3a63dd954d 100644 --- a/docs/dyn/alloydb_v1alpha.projects.locations.html +++ b/docs/dyn/alloydb_v1alpha.projects.locations.html @@ -84,6 +84,11 @@

Instance Methods

Returns the clusters Resource.

+

+ endpoints() +

+

Returns the endpoints Resource.

+

operations()

@@ -102,7 +107,7 @@

Instance Methods

Gets information about a location.

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

-

Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.

+

Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.

list_next()

Retrieves the next page of results.

@@ -141,7 +146,7 @@

Method Details

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
+  
Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
diff --git a/docs/dyn/alloydb_v1beta.projects.locations.clusters.html b/docs/dyn/alloydb_v1beta.projects.locations.clusters.html
index cde8c41312..2e023c8556 100644
--- a/docs/dyn/alloydb_v1beta.projects.locations.clusters.html
+++ b/docs/dyn/alloydb_v1beta.projects.locations.clusters.html
@@ -1494,6 +1494,7 @@ 

Method Details

{ # Message for promoting a Cluster "etag": "A String", # Optional. The current etag of the Cluster. If an etag is provided and does not match the current etag of the Cluster, deletion will be blocked and an ABORTED error will be returned. + "failover": True or False, # Optional. If set, the promote operation will attempt to recreate the original primary cluster as a secondary cluster when it comes back online. Otherwise, the promoted cluster will be a standalone cluster. Currently only supported when there is a single secondary cluster. "requestId": "A String", # Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). "validateOnly": True or False, # Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request. } diff --git a/docs/dyn/alloydb_v1beta.projects.locations.clusters.instances.html b/docs/dyn/alloydb_v1beta.projects.locations.clusters.instances.html index 9ae6ac47c4..79fde6419d 100644 --- a/docs/dyn/alloydb_v1beta.projects.locations.clusters.instances.html +++ b/docs/dyn/alloydb_v1beta.projects.locations.clusters.instances.html @@ -186,6 +186,7 @@

Method Details

{ # Details of a single node in the instance. Nodes in an AlloyDB instance are ephemeral, they can change during update, failover, autohealing and resize operations. "id": "A String", # Output only. The identifier of the VM e.g. "test-read-0601-407e52be-ms3l". "ip": "A String", # Output only. The private IP address of the VM e.g. "10.57.0.34". + "isHotStandby": True or False, # Output only. Indicates whether the node set up to be configured as a hot standby. "state": "A String", # Output only. Determined by state of the compute VM and postgres-service health. Compute VM state can have values listed in https://cloud.google.com/compute/docs/instances/instance-life-cycle and postgres-service health can have values: HEALTHY and UNHEALTHY. "zoneId": "A String", # Output only. The Compute Engine zone of the VM e.g. "us-central1-b". }, @@ -269,6 +270,7 @@

Method Details

"writableNode": { # Details of a single node in the instance. Nodes in an AlloyDB instance are ephemeral, they can change during update, failover, autohealing and resize operations. # Output only. This is set for the read-write VM of the PRIMARY instance only. "id": "A String", # Output only. The identifier of the VM e.g. "test-read-0601-407e52be-ms3l". "ip": "A String", # Output only. The private IP address of the VM e.g. "10.57.0.34". + "isHotStandby": True or False, # Output only. Indicates whether the node set up to be configured as a hot standby. "state": "A String", # Output only. Determined by state of the compute VM and postgres-service health. Compute VM state can have values listed in https://cloud.google.com/compute/docs/instances/instance-life-cycle and postgres-service health can have values: HEALTHY and UNHEALTHY. "zoneId": "A String", # Output only. The Compute Engine zone of the VM e.g. "us-central1-b". }, @@ -376,6 +378,7 @@

Method Details

{ # Details of a single node in the instance. Nodes in an AlloyDB instance are ephemeral, they can change during update, failover, autohealing and resize operations. "id": "A String", # Output only. The identifier of the VM e.g. "test-read-0601-407e52be-ms3l". "ip": "A String", # Output only. The private IP address of the VM e.g. "10.57.0.34". + "isHotStandby": True or False, # Output only. Indicates whether the node set up to be configured as a hot standby. "state": "A String", # Output only. Determined by state of the compute VM and postgres-service health. Compute VM state can have values listed in https://cloud.google.com/compute/docs/instances/instance-life-cycle and postgres-service health can have values: HEALTHY and UNHEALTHY. "zoneId": "A String", # Output only. The Compute Engine zone of the VM e.g. "us-central1-b". }, @@ -459,6 +462,7 @@

Method Details

"writableNode": { # Details of a single node in the instance. Nodes in an AlloyDB instance are ephemeral, they can change during update, failover, autohealing and resize operations. # Output only. This is set for the read-write VM of the PRIMARY instance only. "id": "A String", # Output only. The identifier of the VM e.g. "test-read-0601-407e52be-ms3l". "ip": "A String", # Output only. The private IP address of the VM e.g. "10.57.0.34". + "isHotStandby": True or False, # Output only. Indicates whether the node set up to be configured as a hot standby. "state": "A String", # Output only. Determined by state of the compute VM and postgres-service health. Compute VM state can have values listed in https://cloud.google.com/compute/docs/instances/instance-life-cycle and postgres-service health can have values: HEALTHY and UNHEALTHY. "zoneId": "A String", # Output only. The Compute Engine zone of the VM e.g. "us-central1-b". }, @@ -657,6 +661,7 @@

Method Details

{ # Details of a single node in the instance. Nodes in an AlloyDB instance are ephemeral, they can change during update, failover, autohealing and resize operations. "id": "A String", # Output only. The identifier of the VM e.g. "test-read-0601-407e52be-ms3l". "ip": "A String", # Output only. The private IP address of the VM e.g. "10.57.0.34". + "isHotStandby": True or False, # Output only. Indicates whether the node set up to be configured as a hot standby. "state": "A String", # Output only. Determined by state of the compute VM and postgres-service health. Compute VM state can have values listed in https://cloud.google.com/compute/docs/instances/instance-life-cycle and postgres-service health can have values: HEALTHY and UNHEALTHY. "zoneId": "A String", # Output only. The Compute Engine zone of the VM e.g. "us-central1-b". }, @@ -740,6 +745,7 @@

Method Details

"writableNode": { # Details of a single node in the instance. Nodes in an AlloyDB instance are ephemeral, they can change during update, failover, autohealing and resize operations. # Output only. This is set for the read-write VM of the PRIMARY instance only. "id": "A String", # Output only. The identifier of the VM e.g. "test-read-0601-407e52be-ms3l". "ip": "A String", # Output only. The private IP address of the VM e.g. "10.57.0.34". + "isHotStandby": True or False, # Output only. Indicates whether the node set up to be configured as a hot standby. "state": "A String", # Output only. Determined by state of the compute VM and postgres-service health. Compute VM state can have values listed in https://cloud.google.com/compute/docs/instances/instance-life-cycle and postgres-service health can have values: HEALTHY and UNHEALTHY. "zoneId": "A String", # Output only. The Compute Engine zone of the VM e.g. "us-central1-b". }, @@ -898,6 +904,7 @@

Method Details

{ # Details of a single node in the instance. Nodes in an AlloyDB instance are ephemeral, they can change during update, failover, autohealing and resize operations. "id": "A String", # Output only. The identifier of the VM e.g. "test-read-0601-407e52be-ms3l". "ip": "A String", # Output only. The private IP address of the VM e.g. "10.57.0.34". + "isHotStandby": True or False, # Output only. Indicates whether the node set up to be configured as a hot standby. "state": "A String", # Output only. Determined by state of the compute VM and postgres-service health. Compute VM state can have values listed in https://cloud.google.com/compute/docs/instances/instance-life-cycle and postgres-service health can have values: HEALTHY and UNHEALTHY. "zoneId": "A String", # Output only. The Compute Engine zone of the VM e.g. "us-central1-b". }, @@ -981,6 +988,7 @@

Method Details

"writableNode": { # Details of a single node in the instance. Nodes in an AlloyDB instance are ephemeral, they can change during update, failover, autohealing and resize operations. # Output only. This is set for the read-write VM of the PRIMARY instance only. "id": "A String", # Output only. The identifier of the VM e.g. "test-read-0601-407e52be-ms3l". "ip": "A String", # Output only. The private IP address of the VM e.g. "10.57.0.34". + "isHotStandby": True or False, # Output only. Indicates whether the node set up to be configured as a hot standby. "state": "A String", # Output only. Determined by state of the compute VM and postgres-service health. Compute VM state can have values listed in https://cloud.google.com/compute/docs/instances/instance-life-cycle and postgres-service health can have values: HEALTHY and UNHEALTHY. "zoneId": "A String", # Output only. The Compute Engine zone of the VM e.g. "us-central1-b". }, @@ -1077,6 +1085,7 @@

Method Details

{ # Details of a single node in the instance. Nodes in an AlloyDB instance are ephemeral, they can change during update, failover, autohealing and resize operations. "id": "A String", # Output only. The identifier of the VM e.g. "test-read-0601-407e52be-ms3l". "ip": "A String", # Output only. The private IP address of the VM e.g. "10.57.0.34". + "isHotStandby": True or False, # Output only. Indicates whether the node set up to be configured as a hot standby. "state": "A String", # Output only. Determined by state of the compute VM and postgres-service health. Compute VM state can have values listed in https://cloud.google.com/compute/docs/instances/instance-life-cycle and postgres-service health can have values: HEALTHY and UNHEALTHY. "zoneId": "A String", # Output only. The Compute Engine zone of the VM e.g. "us-central1-b". }, @@ -1160,6 +1169,7 @@

Method Details

"writableNode": { # Details of a single node in the instance. Nodes in an AlloyDB instance are ephemeral, they can change during update, failover, autohealing and resize operations. # Output only. This is set for the read-write VM of the PRIMARY instance only. "id": "A String", # Output only. The identifier of the VM e.g. "test-read-0601-407e52be-ms3l". "ip": "A String", # Output only. The private IP address of the VM e.g. "10.57.0.34". + "isHotStandby": True or False, # Output only. Indicates whether the node set up to be configured as a hot standby. "state": "A String", # Output only. Determined by state of the compute VM and postgres-service health. Compute VM state can have values listed in https://cloud.google.com/compute/docs/instances/instance-life-cycle and postgres-service health can have values: HEALTHY and UNHEALTHY. "zoneId": "A String", # Output only. The Compute Engine zone of the VM e.g. "us-central1-b". }, diff --git a/docs/dyn/alloydb_v1beta.projects.locations.endpoints.html b/docs/dyn/alloydb_v1beta.projects.locations.endpoints.html new file mode 100644 index 0000000000..a8377131af --- /dev/null +++ b/docs/dyn/alloydb_v1beta.projects.locations.endpoints.html @@ -0,0 +1,385 @@ + + + +

AlloyDB API . projects . locations . endpoints

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ create(parent, body=None, endpointId=None, requestId=None, validateOnly=None, x__xgafv=None)

+

Creates a new Endpoint in a given project and location.

+

+ delete(name, etag=None, requestId=None, validateOnly=None, x__xgafv=None)

+

Deletes a single Endpoint.

+

+ get(name, x__xgafv=None)

+

Gets details of a single Endpoint.

+

+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists Endpoints in a given project and location.

+

+ list_next()

+

Retrieves the next page of results.

+

+ patch(name, allowMissing=None, body=None, requestId=None, updateMask=None, validateOnly=None, x__xgafv=None)

+

Updates the parameters of a single Endpoint.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, endpointId=None, requestId=None, validateOnly=None, x__xgafv=None) +
Creates a new Endpoint in a given project and location.
+
+Args:
+  parent: string, Required. The location of the new endpoint. For the required format, see the comment on the Endpoint.name field. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Endpoint resource.
+  "annotations": { # Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128
+    "a_key": "A String",
+  },
+  "createTime": "A String", # Output only. Create time stamp
+  "deleteTime": "A String", # Output only. Delete time stamp
+  "displayName": "A String", # User-settable and human-readable display name for the Endpoint.
+  "dnsConfig": { # The DNS config for the endpoint, containing the DNS record name, type and targets. # Output only. The DNS config for the endpoint. Each endpoint is associated with a specific DNS name and the DNS type. The DNS targets are the IP addresses of the target instances. The dns_type is the type of the DNS record, eg. Type "A" or Type "CNAME". This field is not configurable by the user, and it is updated when user specifies the target instances.
+    "dnsName": "A String", # The fully qualified domain name (FQDN) of the DNS record, e.g., ".location.alloydb-psa.goog".
+    "dnsRecordType": "A String", # The type of the DNS record, e.g., "A", "AAAA", "CNAME".
+  },
+  "effectiveTargetInstances": [ # Output only. The effective target instances that the endpoint is associated with. This is a list of target instance names, e.g. projects/{project_number}/locations/{location}/clusters/{cluster_id}/instances/{instance_id} For write endpoint, there is only one effective target instance which has to be a primary instance. Effective target instances are only different from target instances after a switchover or cross-region failover operation. Otherwise, effective_target_instances are the same as target_instances. Note that after a cross-region failover operation, the effective_target_instances can be stale until the operation to update the endpoint is complete.
+    "A String",
+  ],
+  "endpointType": "A String", # The type of the endpoint, either write or read.
+  "etag": "A String", # For Resource freshness validation (https://google.aip.dev/154)
+  "name": "A String", # Output only. Identifier. The name of the endpoint resource with the format: * projects/{project}/locations/{region}/endpoints/{endpoint_id} where the endpoint ID segment should satisfy the regex expression `[a-z0-9-]+`. For more details see https://google.aip.dev/122. The prefix of the endpoint resource name is the name of the parent resource: * projects/{project}/locations/{region}
+  "reconciling": True or False, # Output only. Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of Endpoint does not match the user's intended state, and the service is actively updating the Endpoint to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance.
+  "state": "A String", # Output only. The state of the endpoint.
+  "targetInstances": [ # The names of the target instances for the endpoint, should be of format projects/{project}/locations/{region}/clusters/{cluster}/instances/{instance}. For write endpoint, there is only one target instance which has to be a primary instance. For read endpoint, there can be multiple target instances which can be read or secondary instances. After a cross-region failover or switchover operation, the endpoint will be associated with a different target instance. This change will be reflected in the effective_target_instances field.
+    "A String",
+  ],
+  "uid": "A String", # Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.
+  "updateTime": "A String", # Output only. Update time stamp
+}
+
+  endpointId: string, Required. ID of the requesting object.
+  requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+  validateOnly: boolean, Optional. If set, the backend validates the request, but doesn't actually execute it.
+  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, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ delete(name, etag=None, requestId=None, validateOnly=None, x__xgafv=None) +
Deletes a single Endpoint.
+
+Args:
+  name: string, Required. The name of the resource. For the required format, see the comment on the Endpoint.name field. (required)
+  etag: string, Optional. The current etag of the Endpoint. If an etag is provided and does not match the current etag of the Endpoint, deletion will be blocked and an ABORTED error will be returned.
+  requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+  validateOnly: boolean, Optional. If set, the backend validates the request, but doesn't actually execute it.
+  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, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ get(name, x__xgafv=None) +
Gets details of a single Endpoint.
+
+Args:
+  name: string, Required. The name of the resource. For the required format, see the comment on the Endpoint.name field. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Endpoint resource.
+  "annotations": { # Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128
+    "a_key": "A String",
+  },
+  "createTime": "A String", # Output only. Create time stamp
+  "deleteTime": "A String", # Output only. Delete time stamp
+  "displayName": "A String", # User-settable and human-readable display name for the Endpoint.
+  "dnsConfig": { # The DNS config for the endpoint, containing the DNS record name, type and targets. # Output only. The DNS config for the endpoint. Each endpoint is associated with a specific DNS name and the DNS type. The DNS targets are the IP addresses of the target instances. The dns_type is the type of the DNS record, eg. Type "A" or Type "CNAME". This field is not configurable by the user, and it is updated when user specifies the target instances.
+    "dnsName": "A String", # The fully qualified domain name (FQDN) of the DNS record, e.g., ".location.alloydb-psa.goog".
+    "dnsRecordType": "A String", # The type of the DNS record, e.g., "A", "AAAA", "CNAME".
+  },
+  "effectiveTargetInstances": [ # Output only. The effective target instances that the endpoint is associated with. This is a list of target instance names, e.g. projects/{project_number}/locations/{location}/clusters/{cluster_id}/instances/{instance_id} For write endpoint, there is only one effective target instance which has to be a primary instance. Effective target instances are only different from target instances after a switchover or cross-region failover operation. Otherwise, effective_target_instances are the same as target_instances. Note that after a cross-region failover operation, the effective_target_instances can be stale until the operation to update the endpoint is complete.
+    "A String",
+  ],
+  "endpointType": "A String", # The type of the endpoint, either write or read.
+  "etag": "A String", # For Resource freshness validation (https://google.aip.dev/154)
+  "name": "A String", # Output only. Identifier. The name of the endpoint resource with the format: * projects/{project}/locations/{region}/endpoints/{endpoint_id} where the endpoint ID segment should satisfy the regex expression `[a-z0-9-]+`. For more details see https://google.aip.dev/122. The prefix of the endpoint resource name is the name of the parent resource: * projects/{project}/locations/{region}
+  "reconciling": True or False, # Output only. Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of Endpoint does not match the user's intended state, and the service is actively updating the Endpoint to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance.
+  "state": "A String", # Output only. The state of the endpoint.
+  "targetInstances": [ # The names of the target instances for the endpoint, should be of format projects/{project}/locations/{region}/clusters/{cluster}/instances/{instance}. For write endpoint, there is only one target instance which has to be a primary instance. For read endpoint, there can be multiple target instances which can be read or secondary instances. After a cross-region failover or switchover operation, the endpoint will be associated with a different target instance. This change will be reflected in the effective_target_instances field.
+    "A String",
+  ],
+  "uid": "A String", # Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.
+  "updateTime": "A String", # Output only. Update time stamp
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists Endpoints in a given project and location.
+
+Args:
+  parent: string, Required. The name of the parent resource. For the required format, see the comment on the Endpoint.name field. Additionally, you can perform an aggregated list operation by specifying a value with the following format: * projects/{project}/locations/- (required)
+  filter: string, Optional. Filtering results. This field is currently not supported, its value will be ignored if passed.
+  orderBy: string, Optional. Hint for how to order the results
+  pageSize: integer, Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
+  pageToken: string, Optional. A page token, received from a previous `ListEndpoints` call. This should be provided to retrieve the subsequent page. This field is currently not supported, its value will be ignored if passed.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message for response to listing Endpoints
+  "endpoints": [ # The list of Endpoints
+    { # Endpoint resource.
+      "annotations": { # Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128
+        "a_key": "A String",
+      },
+      "createTime": "A String", # Output only. Create time stamp
+      "deleteTime": "A String", # Output only. Delete time stamp
+      "displayName": "A String", # User-settable and human-readable display name for the Endpoint.
+      "dnsConfig": { # The DNS config for the endpoint, containing the DNS record name, type and targets. # Output only. The DNS config for the endpoint. Each endpoint is associated with a specific DNS name and the DNS type. The DNS targets are the IP addresses of the target instances. The dns_type is the type of the DNS record, eg. Type "A" or Type "CNAME". This field is not configurable by the user, and it is updated when user specifies the target instances.
+        "dnsName": "A String", # The fully qualified domain name (FQDN) of the DNS record, e.g., ".location.alloydb-psa.goog".
+        "dnsRecordType": "A String", # The type of the DNS record, e.g., "A", "AAAA", "CNAME".
+      },
+      "effectiveTargetInstances": [ # Output only. The effective target instances that the endpoint is associated with. This is a list of target instance names, e.g. projects/{project_number}/locations/{location}/clusters/{cluster_id}/instances/{instance_id} For write endpoint, there is only one effective target instance which has to be a primary instance. Effective target instances are only different from target instances after a switchover or cross-region failover operation. Otherwise, effective_target_instances are the same as target_instances. Note that after a cross-region failover operation, the effective_target_instances can be stale until the operation to update the endpoint is complete.
+        "A String",
+      ],
+      "endpointType": "A String", # The type of the endpoint, either write or read.
+      "etag": "A String", # For Resource freshness validation (https://google.aip.dev/154)
+      "name": "A String", # Output only. Identifier. The name of the endpoint resource with the format: * projects/{project}/locations/{region}/endpoints/{endpoint_id} where the endpoint ID segment should satisfy the regex expression `[a-z0-9-]+`. For more details see https://google.aip.dev/122. The prefix of the endpoint resource name is the name of the parent resource: * projects/{project}/locations/{region}
+      "reconciling": True or False, # Output only. Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of Endpoint does not match the user's intended state, and the service is actively updating the Endpoint to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance.
+      "state": "A String", # Output only. The state of the endpoint.
+      "targetInstances": [ # The names of the target instances for the endpoint, should be of format projects/{project}/locations/{region}/clusters/{cluster}/instances/{instance}. For write endpoint, there is only one target instance which has to be a primary instance. For read endpoint, there can be multiple target instances which can be read or secondary instances. After a cross-region failover or switchover operation, the endpoint will be associated with a different target instance. This change will be reflected in the effective_target_instances field.
+        "A String",
+      ],
+      "uid": "A String", # Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.
+      "updateTime": "A String", # Output only. Update time stamp
+    },
+  ],
+  "nextPageToken": "A String", # A token identifying a page of results the server should return.
+  "unreachable": [ # Locations that could not be reached.
+    "A String",
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(name, allowMissing=None, body=None, requestId=None, updateMask=None, validateOnly=None, x__xgafv=None) +
Updates the parameters of a single Endpoint.
+
+Args:
+  name: string, Output only. Identifier. The name of the endpoint resource with the format: * projects/{project}/locations/{region}/endpoints/{endpoint_id} where the endpoint ID segment should satisfy the regex expression `[a-z0-9-]+`. For more details see https://google.aip.dev/122. The prefix of the endpoint resource name is the name of the parent resource: * projects/{project}/locations/{region} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Endpoint resource.
+  "annotations": { # Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128
+    "a_key": "A String",
+  },
+  "createTime": "A String", # Output only. Create time stamp
+  "deleteTime": "A String", # Output only. Delete time stamp
+  "displayName": "A String", # User-settable and human-readable display name for the Endpoint.
+  "dnsConfig": { # The DNS config for the endpoint, containing the DNS record name, type and targets. # Output only. The DNS config for the endpoint. Each endpoint is associated with a specific DNS name and the DNS type. The DNS targets are the IP addresses of the target instances. The dns_type is the type of the DNS record, eg. Type "A" or Type "CNAME". This field is not configurable by the user, and it is updated when user specifies the target instances.
+    "dnsName": "A String", # The fully qualified domain name (FQDN) of the DNS record, e.g., ".location.alloydb-psa.goog".
+    "dnsRecordType": "A String", # The type of the DNS record, e.g., "A", "AAAA", "CNAME".
+  },
+  "effectiveTargetInstances": [ # Output only. The effective target instances that the endpoint is associated with. This is a list of target instance names, e.g. projects/{project_number}/locations/{location}/clusters/{cluster_id}/instances/{instance_id} For write endpoint, there is only one effective target instance which has to be a primary instance. Effective target instances are only different from target instances after a switchover or cross-region failover operation. Otherwise, effective_target_instances are the same as target_instances. Note that after a cross-region failover operation, the effective_target_instances can be stale until the operation to update the endpoint is complete.
+    "A String",
+  ],
+  "endpointType": "A String", # The type of the endpoint, either write or read.
+  "etag": "A String", # For Resource freshness validation (https://google.aip.dev/154)
+  "name": "A String", # Output only. Identifier. The name of the endpoint resource with the format: * projects/{project}/locations/{region}/endpoints/{endpoint_id} where the endpoint ID segment should satisfy the regex expression `[a-z0-9-]+`. For more details see https://google.aip.dev/122. The prefix of the endpoint resource name is the name of the parent resource: * projects/{project}/locations/{region}
+  "reconciling": True or False, # Output only. Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of Endpoint does not match the user's intended state, and the service is actively updating the Endpoint to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance.
+  "state": "A String", # Output only. The state of the endpoint.
+  "targetInstances": [ # The names of the target instances for the endpoint, should be of format projects/{project}/locations/{region}/clusters/{cluster}/instances/{instance}. For write endpoint, there is only one target instance which has to be a primary instance. For read endpoint, there can be multiple target instances which can be read or secondary instances. After a cross-region failover or switchover operation, the endpoint will be associated with a different target instance. This change will be reflected in the effective_target_instances field.
+    "A String",
+  ],
+  "uid": "A String", # Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.
+  "updateTime": "A String", # Output only. Update time stamp
+}
+
+  allowMissing: boolean, Optional. If set to true, update succeeds even if endpoint is not found. In that case, a new endpoint is created and `update_mask` is ignored.
+  requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+  updateMask: string, Optional. Field mask is used to specify the fields to be overwritten in the Endpoint resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
+  validateOnly: boolean, Optional. If set, the backend validates the request, but doesn't actually execute it.
+  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, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/alloydb_v1beta.projects.locations.html b/docs/dyn/alloydb_v1beta.projects.locations.html index c22df95f8c..d470514f39 100644 --- a/docs/dyn/alloydb_v1beta.projects.locations.html +++ b/docs/dyn/alloydb_v1beta.projects.locations.html @@ -84,6 +84,11 @@

Instance Methods

Returns the clusters Resource.

+

+ endpoints() +

+

Returns the endpoints Resource.

+

operations()

@@ -102,7 +107,7 @@

Instance Methods

Gets information about a location.

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

-

Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.

+

Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.

list_next()

Retrieves the next page of results.

@@ -141,7 +146,7 @@

Method Details

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
+  
Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
diff --git a/docs/dyn/analyticsadmin_v1alpha.accountSummaries.html b/docs/dyn/analyticsadmin_v1alpha.accountSummaries.html
index 00f4f08ce8..fef2715862 100644
--- a/docs/dyn/analyticsadmin_v1alpha.accountSummaries.html
+++ b/docs/dyn/analyticsadmin_v1alpha.accountSummaries.html
@@ -94,8 +94,8 @@ 

Method Details

Returns summaries of all accounts accessible by the caller.
 
 Args:
-  pageSize: integer, The maximum number of AccountSummary resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)
-  pageToken: string, A page token, received from a previous `ListAccountSummaries` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccountSummaries` must match the call that provided the page token.
+  pageSize: integer, Optional. The maximum number of AccountSummary resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)
+  pageToken: string, Optional. A page token, received from a previous `ListAccountSummaries` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccountSummaries` must match the call that provided the page token.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -109,7 +109,7 @@ 

Method Details

{ # A virtual resource representing an overview of an account and all its child Google Analytics properties. "account": "A String", # Resource name of account referred to by this account summary Format: accounts/{account_id} Example: "accounts/1000" "displayName": "A String", # Display name for the account referred to in this account summary. - "name": "A String", # Resource name for this account summary. Format: accountSummaries/{account_id} Example: "accountSummaries/1000" + "name": "A String", # Identifier. Resource name for this account summary. Format: accountSummaries/{account_id} Example: "accountSummaries/1000" "propertySummaries": [ # List of summaries for child accounts of this account. { # A virtual resource representing metadata for a Google Analytics property. "displayName": "A String", # Display name for the property referred to in this property summary. diff --git a/docs/dyn/analyticsadmin_v1alpha.accounts.html b/docs/dyn/analyticsadmin_v1alpha.accounts.html index c36c0d1f88..d1842896a6 100644 --- a/docs/dyn/analyticsadmin_v1alpha.accounts.html +++ b/docs/dyn/analyticsadmin_v1alpha.accounts.html @@ -155,7 +155,7 @@

Method Details

"deleted": True or False, # Output only. Indicates whether this Account is soft-deleted or not. Deleted accounts are excluded from List results unless specifically requested. "displayName": "A String", # Required. Human-readable display name for this account. "gmpOrganization": "A String", # Output only. The URI for a Google Marketing Platform organization resource. Only set when this account is connected to a GMP organization. Format: marketingplatformadmin.googleapis.com/organizations/{org_id} - "name": "A String", # Output only. Resource name of this account. Format: accounts/{account} Example: "accounts/100" + "name": "A String", # Identifier. Resource name of this account. Format: accounts/{account} Example: "accounts/100" "regionCode": "A String", # Country of business. Must be a Unicode CLDR region code. "updateTime": "A String", # Output only. Time when account payload fields were last updated. }
@@ -176,7 +176,7 @@

Method Details

An object of the form: { # A resource message representing data sharing settings of a Google Analytics account. - "name": "A String", # Output only. Resource name. Format: accounts/{account}/dataSharingSettings Example: "accounts/1000/dataSharingSettings" + "name": "A String", # Identifier. Resource name. Format: accounts/{account}/dataSharingSettings Example: "accounts/1000/dataSharingSettings" "sharingWithGoogleAnySalesEnabled": True or False, # Deprecated. This field is no longer used and always returns false. "sharingWithGoogleAssignedSalesEnabled": True or False, # Allows Google access to your Google Analytics account data, including account usage and configuration data, product spending, and users associated with your Google Analytics account, so that Google can help you make the most of Google products, providing you with insights, offers, recommendations, and optimization tips across Google Analytics and other Google products for business. This field maps to the "Recommendations for your business" field in the Google Analytics Admin UI. "sharingWithGoogleProductsEnabled": True or False, # Allows Google to use the data to improve other Google products or services. This fields maps to the "Google products & services" field in the Google Analytics Admin UI. @@ -190,8 +190,8 @@

Method Details

Returns all accounts accessible by the caller. Note that these accounts might not currently have GA properties. Soft-deleted (ie: "trashed") accounts are excluded by default. Returns an empty list if no relevant accounts are found.
 
 Args:
-  pageSize: integer, The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)
-  pageToken: string, A page token, received from a previous `ListAccounts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccounts` must match the call that provided the page token.
+  pageSize: integer, Optional. The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)
+  pageToken: string, Optional. A page token, received from a previous `ListAccounts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccounts` must match the call that provided the page token.
   showDeleted: boolean, Whether to include soft-deleted (ie: "trashed") Accounts in the results. Accounts can be inspected to determine whether they are deleted or not.
   x__xgafv: string, V1 error format.
     Allowed values
@@ -208,7 +208,7 @@ 

Method Details

"deleted": True or False, # Output only. Indicates whether this Account is soft-deleted or not. Deleted accounts are excluded from List results unless specifically requested. "displayName": "A String", # Required. Human-readable display name for this account. "gmpOrganization": "A String", # Output only. The URI for a Google Marketing Platform organization resource. Only set when this account is connected to a GMP organization. Format: marketingplatformadmin.googleapis.com/organizations/{org_id} - "name": "A String", # Output only. Resource name of this account. Format: accounts/{account} Example: "accounts/100" + "name": "A String", # Identifier. Resource name of this account. Format: accounts/{account} Example: "accounts/100" "regionCode": "A String", # Country of business. Must be a Unicode CLDR region code. "updateTime": "A String", # Output only. Time when account payload fields were last updated. }, @@ -236,7 +236,7 @@

Method Details

Updates an account.
 
 Args:
-  name: string, Output only. Resource name of this account. Format: accounts/{account} Example: "accounts/100" (required)
+  name: string, Identifier. Resource name of this account. Format: accounts/{account} Example: "accounts/100" (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -245,7 +245,7 @@ 

Method Details

"deleted": True or False, # Output only. Indicates whether this Account is soft-deleted or not. Deleted accounts are excluded from List results unless specifically requested. "displayName": "A String", # Required. Human-readable display name for this account. "gmpOrganization": "A String", # Output only. The URI for a Google Marketing Platform organization resource. Only set when this account is connected to a GMP organization. Format: marketingplatformadmin.googleapis.com/organizations/{org_id} - "name": "A String", # Output only. Resource name of this account. Format: accounts/{account} Example: "accounts/100" + "name": "A String", # Identifier. Resource name of this account. Format: accounts/{account} Example: "accounts/100" "regionCode": "A String", # Country of business. Must be a Unicode CLDR region code. "updateTime": "A String", # Output only. Time when account payload fields were last updated. } @@ -264,7 +264,7 @@

Method Details

"deleted": True or False, # Output only. Indicates whether this Account is soft-deleted or not. Deleted accounts are excluded from List results unless specifically requested. "displayName": "A String", # Required. Human-readable display name for this account. "gmpOrganization": "A String", # Output only. The URI for a Google Marketing Platform organization resource. Only set when this account is connected to a GMP organization. Format: marketingplatformadmin.googleapis.com/organizations/{org_id} - "name": "A String", # Output only. Resource name of this account. Format: accounts/{account} Example: "accounts/100" + "name": "A String", # Identifier. Resource name of this account. Format: accounts/{account} Example: "accounts/100" "regionCode": "A String", # Country of business. Must be a Unicode CLDR region code. "updateTime": "A String", # Output only. Time when account payload fields were last updated. }
@@ -284,7 +284,7 @@

Method Details

"deleted": True or False, # Output only. Indicates whether this Account is soft-deleted or not. Deleted accounts are excluded from List results unless specifically requested. "displayName": "A String", # Required. Human-readable display name for this account. "gmpOrganization": "A String", # Output only. The URI for a Google Marketing Platform organization resource. Only set when this account is connected to a GMP organization. Format: marketingplatformadmin.googleapis.com/organizations/{org_id} - "name": "A String", # Output only. Resource name of this account. Format: accounts/{account} Example: "accounts/100" + "name": "A String", # Identifier. Resource name of this account. Format: accounts/{account} Example: "accounts/100" "regionCode": "A String", # Country of business. Must be a Unicode CLDR region code. "updateTime": "A String", # Output only. Time when account payload fields were last updated. }, @@ -546,7 +546,7 @@

Method Details

"deleted": True or False, # Output only. Indicates whether this Account is soft-deleted or not. Deleted accounts are excluded from List results unless specifically requested. "displayName": "A String", # Required. Human-readable display name for this account. "gmpOrganization": "A String", # Output only. The URI for a Google Marketing Platform organization resource. Only set when this account is connected to a GMP organization. Format: marketingplatformadmin.googleapis.com/organizations/{org_id} - "name": "A String", # Output only. Resource name of this account. Format: accounts/{account} Example: "accounts/100" + "name": "A String", # Identifier. Resource name of this account. Format: accounts/{account} Example: "accounts/100" "regionCode": "A String", # Country of business. Must be a Unicode CLDR region code. "updateTime": "A String", # Output only. Time when account payload fields were last updated. }, @@ -716,7 +716,7 @@

Method Details

"formula": "A String", # Required. The calculated metric's definition. Maximum number of unique referenced custom metrics is 5. Formulas supports the following operations: + (addition), - (subtraction), - (negative), * (multiplication), / (division), () (parenthesis). Any valid real numbers are acceptable that fit in a Long (64bit integer) or a Double (64 bit floating point number). Example formula: "( customEvent:parameter_name + cartPurchaseQuantity ) / 2.0" "invalidMetricReference": True or False, # Output only. If true, this calculated metric has a invalid metric reference. Anything using a calculated metric with invalid_metric_reference set to true may fail, produce warnings, or produce unexpected results. "metricUnit": "A String", # Required. The type for the calculated metric's value. - "name": "A String", # Output only. Resource name for this CalculatedMetric. Format: 'properties/{property_id}/calculatedMetrics/{calculated_metric_id}' + "name": "A String", # Identifier. Resource name for this CalculatedMetric. Format: 'properties/{property_id}/calculatedMetrics/{calculated_metric_id}' "restrictedMetricType": [ # Output only. Types of restricted data that this metric contains. "A String", ], @@ -768,13 +768,13 @@

Method Details

}, "deletable": True or False, # Output only. If set, this event can currently be deleted with DeleteConversionEvent. "eventName": "A String", # Immutable. The event name for this conversion event. Examples: 'click', 'purchase' - "name": "A String", # Output only. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event} + "name": "A String", # Identifier. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event} }, "customDimension": { # A definition for a CustomDimension. # A snapshot of a CustomDimension resource in change history. "description": "A String", # Optional. Description for this custom dimension. Max length of 150 characters. "disallowAdsPersonalization": True or False, # Optional. If set to true, sets this dimension as NPA and excludes it from ads personalization. This is currently only supported by user-scoped custom dimensions. "displayName": "A String", # Required. Display name for this custom dimension as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets. - "name": "A String", # Output only. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension} + "name": "A String", # Identifier. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension} "parameterName": "A String", # Required. Immutable. Tagging parameter name for this custom dimension. If this is a user-scoped dimension, then this is the user property name. If this is an event-scoped dimension, then this is the event parameter name. If this is an item-scoped dimension, then this is the parameter name found in the eCommerce items array. May only contain alphanumeric and underscore characters, starting with a letter. Max length of 24 characters for user-scoped dimensions, 40 characters for event-scoped dimensions. "scope": "A String", # Required. Immutable. The scope of this dimension. }, @@ -782,7 +782,7 @@

Method Details

"description": "A String", # Optional. Description for this custom dimension. Max length of 150 characters. "displayName": "A String", # Required. Display name for this custom metric as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets. "measurementUnit": "A String", # Required. The type for the custom metric's value. - "name": "A String", # Output only. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric} + "name": "A String", # Identifier. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric} "parameterName": "A String", # Required. Immutable. Tagging name for this custom metric. If this is an event-scoped metric, then this is the event parameter name. May only contain alphanumeric and underscore charactes, starting with a letter. Max length of 40 characters for event-scoped metrics. "restrictedMetricType": [ # Optional. Types of restricted data that this metric may contain. Required for metrics with CURRENCY measurement unit. Must be empty for metrics with a non-CURRENCY measurement unit. "A String", @@ -799,7 +799,7 @@

Method Details

}, "dataRetentionSettings": { # Settings values for data retention. This is a singleton resource. # A snapshot of a data retention settings resource in change history. "eventDataRetention": "A String", # Required. The length of time that event-level data is retained. - "name": "A String", # Output only. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings + "name": "A String", # Identifier. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings "resetUserDataOnNewActivity": True or False, # If true, reset the retention period for the user identifier with every event from that user. "userDataRetention": "A String", # Required. The length of time that user-level data is retained. }, @@ -814,7 +814,7 @@

Method Details

"bundleId": "A String", # Required. Immutable. The Apple App Store Bundle ID for the app Example: "com.example.myiosapp" "firebaseAppId": "A String", # Output only. ID of the corresponding iOS app in Firebase, if any. This ID can change if the iOS app is deleted and recreated. }, - "name": "A String", # Output only. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: "properties/1000/dataStreams/2000" + "name": "A String", # Identifier. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: "properties/1000/dataStreams/2000" "type": "A String", # Required. Immutable. The type of this DataStream resource. "updateTime": "A String", # Output only. Time when stream payload fields were last updated. "webStreamData": { # Data specific to web streams. # Data specific to web streams. Must be populated if type is WEB_DATA_STREAM. @@ -829,7 +829,7 @@

Method Details

"advertiserId": "A String", # Immutable. The Display & Video 360 Advertiser's advertiser ID. "campaignDataSharingEnabled": True or False, # Immutable. Enables the import of campaign data from Display & Video 360 into the Google Analytics property. After link creation, this can only be updated from the Display & Video 360 product. If this field is not set on create, it will be defaulted to true. "costDataSharingEnabled": True or False, # Immutable. Enables the import of cost data from Display & Video 360 into the Google Analytics property. This can only be enabled if `campaign_data_sharing_enabled` is true. After link creation, this can only be updated from the Display & Video 360 product. If this field is not set on create, it will be defaulted to true. - "name": "A String", # Output only. The resource name for this DisplayVideo360AdvertiserLink resource. Format: properties/{propertyId}/displayVideo360AdvertiserLinks/{linkId} Note: linkId is not the Display & Video 360 Advertiser ID + "name": "A String", # Identifier. The resource name for this DisplayVideo360AdvertiserLink resource. Format: properties/{propertyId}/displayVideo360AdvertiserLinks/{linkId} Note: linkId is not the Display & Video 360 Advertiser ID }, "displayVideo360AdvertiserLinkProposal": { # A proposal for a link between a Google Analytics property and a Display & Video 360 advertiser. A proposal is converted to a DisplayVideo360AdvertiserLink once approved. Google Analytics admins approve inbound proposals while Display & Video 360 admins approve outbound proposals. # A snapshot of a DisplayVideo360AdvertiserLinkProposal resource in change history. "adsPersonalizationEnabled": True or False, # Immutable. Enables personalized advertising features with this integration. If this field is not set on create, it will be defaulted to true. @@ -842,7 +842,7 @@

Method Details

"linkProposalState": "A String", # Output only. The state of this proposal. "requestorEmail": "A String", # Output only. The email address of the user that proposed this linkage. }, - "name": "A String", # Output only. The resource name for this DisplayVideo360AdvertiserLinkProposal resource. Format: properties/{propertyId}/displayVideo360AdvertiserLinkProposals/{proposalId} Note: proposalId is not the Display & Video 360 Advertiser ID + "name": "A String", # Identifier. The resource name for this DisplayVideo360AdvertiserLinkProposal resource. Format: properties/{propertyId}/displayVideo360AdvertiserLinkProposals/{proposalId} Note: proposalId is not the Display & Video 360 Advertiser ID "validationEmail": "A String", # Input only. On a proposal being sent to Display & Video 360, this field must be set to the email address of an admin on the target advertiser. This is used to verify that the Google Analytics admin is aware of at least one admin on the Display & Video 360 Advertiser. This does not restrict approval of the proposal to a single user. Any admin on the Display & Video 360 Advertiser may approve the proposal. }, "enhancedMeasurementSettings": { # Singleton resource under a web DataStream, configuring measurement of additional site interactions and content. # A snapshot of EnhancedMeasurementSettings resource in change history. @@ -913,7 +913,7 @@

Method Details

}, "firebaseLink": { # A link between a Google Analytics property and a Firebase project. # A snapshot of a FirebaseLink resource in change history. "createTime": "A String", # Output only. Time when this FirebaseLink was originally created. - "name": "A String", # Output only. Example format: properties/1234/firebaseLinks/5678 + "name": "A String", # Identifier. Example format: properties/1234/firebaseLinks/5678 "project": "A String", # Immutable. Firebase project resource name. When creating a FirebaseLink, you may provide this resource name using either a project number or project ID. Once this resource has been created, returned FirebaseLinks will always have a project_name that contains a project number. Format: 'projects/{project number}' Example: 'projects/1234' }, "googleAdsLink": { # A link between a Google Analytics property and a Google Ads account. # A snapshot of a GoogleAdsLink resource in change history. @@ -922,7 +922,7 @@

Method Details

"createTime": "A String", # Output only. Time when this link was originally created. "creatorEmailAddress": "A String", # Output only. Email address of the user that created the link. An empty string will be returned if the email address can't be retrieved. "customerId": "A String", # Immutable. Google Ads customer ID. - "name": "A String", # Output only. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID. + "name": "A String", # Identifier. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID. "updateTime": "A String", # Output only. Time when this link was last updated. }, "googleSignalsSettings": { # Settings values for Google Signals. This is a singleton resource. # A snapshot of a GoogleSignalsSettings resource in change history. @@ -944,7 +944,7 @@

Method Details

}, "measurementProtocolSecret": { # A secret value used for sending hits to Measurement Protocol. # A snapshot of a MeasurementProtocolSecret resource in change history. "displayName": "A String", # Required. Human-readable display name for this secret. - "name": "A String", # Output only. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret} + "name": "A String", # Identifier. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret} "secretValue": "A String", # Output only. The measurement protocol secret value. Pass this value to the api_secret field of the Measurement Protocol API when sending hits to this secret's parent property. }, "property": { # A resource message representing a Google Analytics property. # A snapshot of a Property resource in change history. @@ -955,7 +955,7 @@

Method Details

"displayName": "A String", # Required. Human-readable display name for this property. The max allowed display name length is 100 UTF-16 code units. "expireTime": "A String", # Output only. If set, the time at which this trashed property will be permanently deleted. If not set, then this property is not currently in the trash can and is not slated to be deleted. "industryCategory": "A String", # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK - "name": "A String", # Output only. Resource name of this property. Format: properties/{property_id} Example: "properties/1000" + "name": "A String", # Identifier. Resource name of this property. Format: properties/{property_id} Example: "properties/1000" "parent": "A String", # Immutable. Resource name of this property's logical parent. Note: The Property-Moving UI can be used to change the parent. Format: accounts/{account}, properties/{property} Example: "accounts/100", "properties/101" "propertyType": "A String", # Immutable. The property type for this Property resource. When creating a property, if the type is "PROPERTY_TYPE_UNSPECIFIED", then "ORDINARY_PROPERTY" will be implied. "serviceLevel": "A String", # Output only. The Google Analytics service level that applies to this property. @@ -996,12 +996,12 @@

Method Details

"advertiserId": "A String", # Immutable. This field represents the Advertiser ID of the Search Ads 360 Advertiser. that has been linked. "campaignDataSharingEnabled": True or False, # Immutable. Enables the import of campaign data from Search Ads 360 into the Google Analytics property. After link creation, this can only be updated from the Search Ads 360 product. If this field is not set on create, it will be defaulted to true. "costDataSharingEnabled": True or False, # Immutable. Enables the import of cost data from Search Ads 360 to the Google Analytics property. This can only be enabled if campaign_data_sharing_enabled is enabled. After link creation, this can only be updated from the Search Ads 360 product. If this field is not set on create, it will be defaulted to true. - "name": "A String", # Output only. The resource name for this SearchAds360Link resource. Format: properties/{propertyId}/searchAds360Links/{linkId} Note: linkId is not the Search Ads 360 advertiser ID + "name": "A String", # Identifier. The resource name for this SearchAds360Link resource. Format: properties/{propertyId}/searchAds360Links/{linkId} Note: linkId is not the Search Ads 360 advertiser ID "siteStatsSharingEnabled": True or False, # Enables export of site stats with this integration. If this field is not set on create, it will be defaulted to true. }, "skadnetworkConversionValueSchema": { # SKAdNetwork conversion value schema of an iOS stream. # A snapshot of SKAdNetworkConversionValueSchema resource in change history. "applyConversionValues": True or False, # If enabled, the GA SDK will set conversion values using this schema definition, and schema will be exported to any Google Ads accounts linked to this property. If disabled, the GA SDK will not automatically set conversion values, and also the schema will not be exported to Ads. - "name": "A String", # Output only. Resource name of the schema. This will be child of ONLY an iOS stream, and there can be at most one such child under an iOS stream. Format: properties/{property}/dataStreams/{dataStream}/sKAdNetworkConversionValueSchema + "name": "A String", # Identifier. Resource name of the schema. This will be child of ONLY an iOS stream, and there can be at most one such child under an iOS stream. Format: properties/{property}/dataStreams/{dataStream}/sKAdNetworkConversionValueSchema "postbackWindowOne": { # Settings for a SKAdNetwork conversion postback window. # Required. The conversion value settings for the first postback window. These differ from values for postback window two and three in that they contain a "Fine" grained conversion value (a numeric value). Conversion values for this postback window must be set. The other windows are optional and may inherit this window's settings if unset or disabled. "conversionValues": [ # Ordering of the repeated field will be used to prioritize the conversion value settings. Lower indexed entries are prioritized higher. The first conversion value setting that evaluates to true will be selected. It must have at least one entry if enable_postback_window_settings is set to true. It can have maximum of 128 entries. { # Conversion value settings for a postback window for SKAdNetwork conversion value schema. @@ -1075,7 +1075,7 @@

Method Details

"deleted": True or False, # Output only. Indicates whether this Account is soft-deleted or not. Deleted accounts are excluded from List results unless specifically requested. "displayName": "A String", # Required. Human-readable display name for this account. "gmpOrganization": "A String", # Output only. The URI for a Google Marketing Platform organization resource. Only set when this account is connected to a GMP organization. Format: marketingplatformadmin.googleapis.com/organizations/{org_id} - "name": "A String", # Output only. Resource name of this account. Format: accounts/{account} Example: "accounts/100" + "name": "A String", # Identifier. Resource name of this account. Format: accounts/{account} Example: "accounts/100" "regionCode": "A String", # Country of business. Must be a Unicode CLDR region code. "updateTime": "A String", # Output only. Time when account payload fields were last updated. }, @@ -1245,7 +1245,7 @@

Method Details

"formula": "A String", # Required. The calculated metric's definition. Maximum number of unique referenced custom metrics is 5. Formulas supports the following operations: + (addition), - (subtraction), - (negative), * (multiplication), / (division), () (parenthesis). Any valid real numbers are acceptable that fit in a Long (64bit integer) or a Double (64 bit floating point number). Example formula: "( customEvent:parameter_name + cartPurchaseQuantity ) / 2.0" "invalidMetricReference": True or False, # Output only. If true, this calculated metric has a invalid metric reference. Anything using a calculated metric with invalid_metric_reference set to true may fail, produce warnings, or produce unexpected results. "metricUnit": "A String", # Required. The type for the calculated metric's value. - "name": "A String", # Output only. Resource name for this CalculatedMetric. Format: 'properties/{property_id}/calculatedMetrics/{calculated_metric_id}' + "name": "A String", # Identifier. Resource name for this CalculatedMetric. Format: 'properties/{property_id}/calculatedMetrics/{calculated_metric_id}' "restrictedMetricType": [ # Output only. Types of restricted data that this metric contains. "A String", ], @@ -1297,13 +1297,13 @@

Method Details

}, "deletable": True or False, # Output only. If set, this event can currently be deleted with DeleteConversionEvent. "eventName": "A String", # Immutable. The event name for this conversion event. Examples: 'click', 'purchase' - "name": "A String", # Output only. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event} + "name": "A String", # Identifier. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event} }, "customDimension": { # A definition for a CustomDimension. # A snapshot of a CustomDimension resource in change history. "description": "A String", # Optional. Description for this custom dimension. Max length of 150 characters. "disallowAdsPersonalization": True or False, # Optional. If set to true, sets this dimension as NPA and excludes it from ads personalization. This is currently only supported by user-scoped custom dimensions. "displayName": "A String", # Required. Display name for this custom dimension as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets. - "name": "A String", # Output only. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension} + "name": "A String", # Identifier. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension} "parameterName": "A String", # Required. Immutable. Tagging parameter name for this custom dimension. If this is a user-scoped dimension, then this is the user property name. If this is an event-scoped dimension, then this is the event parameter name. If this is an item-scoped dimension, then this is the parameter name found in the eCommerce items array. May only contain alphanumeric and underscore characters, starting with a letter. Max length of 24 characters for user-scoped dimensions, 40 characters for event-scoped dimensions. "scope": "A String", # Required. Immutable. The scope of this dimension. }, @@ -1311,7 +1311,7 @@

Method Details

"description": "A String", # Optional. Description for this custom dimension. Max length of 150 characters. "displayName": "A String", # Required. Display name for this custom metric as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets. "measurementUnit": "A String", # Required. The type for the custom metric's value. - "name": "A String", # Output only. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric} + "name": "A String", # Identifier. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric} "parameterName": "A String", # Required. Immutable. Tagging name for this custom metric. If this is an event-scoped metric, then this is the event parameter name. May only contain alphanumeric and underscore charactes, starting with a letter. Max length of 40 characters for event-scoped metrics. "restrictedMetricType": [ # Optional. Types of restricted data that this metric may contain. Required for metrics with CURRENCY measurement unit. Must be empty for metrics with a non-CURRENCY measurement unit. "A String", @@ -1328,7 +1328,7 @@

Method Details

}, "dataRetentionSettings": { # Settings values for data retention. This is a singleton resource. # A snapshot of a data retention settings resource in change history. "eventDataRetention": "A String", # Required. The length of time that event-level data is retained. - "name": "A String", # Output only. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings + "name": "A String", # Identifier. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings "resetUserDataOnNewActivity": True or False, # If true, reset the retention period for the user identifier with every event from that user. "userDataRetention": "A String", # Required. The length of time that user-level data is retained. }, @@ -1343,7 +1343,7 @@

Method Details

"bundleId": "A String", # Required. Immutable. The Apple App Store Bundle ID for the app Example: "com.example.myiosapp" "firebaseAppId": "A String", # Output only. ID of the corresponding iOS app in Firebase, if any. This ID can change if the iOS app is deleted and recreated. }, - "name": "A String", # Output only. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: "properties/1000/dataStreams/2000" + "name": "A String", # Identifier. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: "properties/1000/dataStreams/2000" "type": "A String", # Required. Immutable. The type of this DataStream resource. "updateTime": "A String", # Output only. Time when stream payload fields were last updated. "webStreamData": { # Data specific to web streams. # Data specific to web streams. Must be populated if type is WEB_DATA_STREAM. @@ -1358,7 +1358,7 @@

Method Details

"advertiserId": "A String", # Immutable. The Display & Video 360 Advertiser's advertiser ID. "campaignDataSharingEnabled": True or False, # Immutable. Enables the import of campaign data from Display & Video 360 into the Google Analytics property. After link creation, this can only be updated from the Display & Video 360 product. If this field is not set on create, it will be defaulted to true. "costDataSharingEnabled": True or False, # Immutable. Enables the import of cost data from Display & Video 360 into the Google Analytics property. This can only be enabled if `campaign_data_sharing_enabled` is true. After link creation, this can only be updated from the Display & Video 360 product. If this field is not set on create, it will be defaulted to true. - "name": "A String", # Output only. The resource name for this DisplayVideo360AdvertiserLink resource. Format: properties/{propertyId}/displayVideo360AdvertiserLinks/{linkId} Note: linkId is not the Display & Video 360 Advertiser ID + "name": "A String", # Identifier. The resource name for this DisplayVideo360AdvertiserLink resource. Format: properties/{propertyId}/displayVideo360AdvertiserLinks/{linkId} Note: linkId is not the Display & Video 360 Advertiser ID }, "displayVideo360AdvertiserLinkProposal": { # A proposal for a link between a Google Analytics property and a Display & Video 360 advertiser. A proposal is converted to a DisplayVideo360AdvertiserLink once approved. Google Analytics admins approve inbound proposals while Display & Video 360 admins approve outbound proposals. # A snapshot of a DisplayVideo360AdvertiserLinkProposal resource in change history. "adsPersonalizationEnabled": True or False, # Immutable. Enables personalized advertising features with this integration. If this field is not set on create, it will be defaulted to true. @@ -1371,7 +1371,7 @@

Method Details

"linkProposalState": "A String", # Output only. The state of this proposal. "requestorEmail": "A String", # Output only. The email address of the user that proposed this linkage. }, - "name": "A String", # Output only. The resource name for this DisplayVideo360AdvertiserLinkProposal resource. Format: properties/{propertyId}/displayVideo360AdvertiserLinkProposals/{proposalId} Note: proposalId is not the Display & Video 360 Advertiser ID + "name": "A String", # Identifier. The resource name for this DisplayVideo360AdvertiserLinkProposal resource. Format: properties/{propertyId}/displayVideo360AdvertiserLinkProposals/{proposalId} Note: proposalId is not the Display & Video 360 Advertiser ID "validationEmail": "A String", # Input only. On a proposal being sent to Display & Video 360, this field must be set to the email address of an admin on the target advertiser. This is used to verify that the Google Analytics admin is aware of at least one admin on the Display & Video 360 Advertiser. This does not restrict approval of the proposal to a single user. Any admin on the Display & Video 360 Advertiser may approve the proposal. }, "enhancedMeasurementSettings": { # Singleton resource under a web DataStream, configuring measurement of additional site interactions and content. # A snapshot of EnhancedMeasurementSettings resource in change history. @@ -1442,7 +1442,7 @@

Method Details

}, "firebaseLink": { # A link between a Google Analytics property and a Firebase project. # A snapshot of a FirebaseLink resource in change history. "createTime": "A String", # Output only. Time when this FirebaseLink was originally created. - "name": "A String", # Output only. Example format: properties/1234/firebaseLinks/5678 + "name": "A String", # Identifier. Example format: properties/1234/firebaseLinks/5678 "project": "A String", # Immutable. Firebase project resource name. When creating a FirebaseLink, you may provide this resource name using either a project number or project ID. Once this resource has been created, returned FirebaseLinks will always have a project_name that contains a project number. Format: 'projects/{project number}' Example: 'projects/1234' }, "googleAdsLink": { # A link between a Google Analytics property and a Google Ads account. # A snapshot of a GoogleAdsLink resource in change history. @@ -1451,7 +1451,7 @@

Method Details

"createTime": "A String", # Output only. Time when this link was originally created. "creatorEmailAddress": "A String", # Output only. Email address of the user that created the link. An empty string will be returned if the email address can't be retrieved. "customerId": "A String", # Immutable. Google Ads customer ID. - "name": "A String", # Output only. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID. + "name": "A String", # Identifier. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID. "updateTime": "A String", # Output only. Time when this link was last updated. }, "googleSignalsSettings": { # Settings values for Google Signals. This is a singleton resource. # A snapshot of a GoogleSignalsSettings resource in change history. @@ -1473,7 +1473,7 @@

Method Details

}, "measurementProtocolSecret": { # A secret value used for sending hits to Measurement Protocol. # A snapshot of a MeasurementProtocolSecret resource in change history. "displayName": "A String", # Required. Human-readable display name for this secret. - "name": "A String", # Output only. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret} + "name": "A String", # Identifier. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret} "secretValue": "A String", # Output only. The measurement protocol secret value. Pass this value to the api_secret field of the Measurement Protocol API when sending hits to this secret's parent property. }, "property": { # A resource message representing a Google Analytics property. # A snapshot of a Property resource in change history. @@ -1484,7 +1484,7 @@

Method Details

"displayName": "A String", # Required. Human-readable display name for this property. The max allowed display name length is 100 UTF-16 code units. "expireTime": "A String", # Output only. If set, the time at which this trashed property will be permanently deleted. If not set, then this property is not currently in the trash can and is not slated to be deleted. "industryCategory": "A String", # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK - "name": "A String", # Output only. Resource name of this property. Format: properties/{property_id} Example: "properties/1000" + "name": "A String", # Identifier. Resource name of this property. Format: properties/{property_id} Example: "properties/1000" "parent": "A String", # Immutable. Resource name of this property's logical parent. Note: The Property-Moving UI can be used to change the parent. Format: accounts/{account}, properties/{property} Example: "accounts/100", "properties/101" "propertyType": "A String", # Immutable. The property type for this Property resource. When creating a property, if the type is "PROPERTY_TYPE_UNSPECIFIED", then "ORDINARY_PROPERTY" will be implied. "serviceLevel": "A String", # Output only. The Google Analytics service level that applies to this property. @@ -1525,12 +1525,12 @@

Method Details

"advertiserId": "A String", # Immutable. This field represents the Advertiser ID of the Search Ads 360 Advertiser. that has been linked. "campaignDataSharingEnabled": True or False, # Immutable. Enables the import of campaign data from Search Ads 360 into the Google Analytics property. After link creation, this can only be updated from the Search Ads 360 product. If this field is not set on create, it will be defaulted to true. "costDataSharingEnabled": True or False, # Immutable. Enables the import of cost data from Search Ads 360 to the Google Analytics property. This can only be enabled if campaign_data_sharing_enabled is enabled. After link creation, this can only be updated from the Search Ads 360 product. If this field is not set on create, it will be defaulted to true. - "name": "A String", # Output only. The resource name for this SearchAds360Link resource. Format: properties/{propertyId}/searchAds360Links/{linkId} Note: linkId is not the Search Ads 360 advertiser ID + "name": "A String", # Identifier. The resource name for this SearchAds360Link resource. Format: properties/{propertyId}/searchAds360Links/{linkId} Note: linkId is not the Search Ads 360 advertiser ID "siteStatsSharingEnabled": True or False, # Enables export of site stats with this integration. If this field is not set on create, it will be defaulted to true. }, "skadnetworkConversionValueSchema": { # SKAdNetwork conversion value schema of an iOS stream. # A snapshot of SKAdNetworkConversionValueSchema resource in change history. "applyConversionValues": True or False, # If enabled, the GA SDK will set conversion values using this schema definition, and schema will be exported to any Google Ads accounts linked to this property. If disabled, the GA SDK will not automatically set conversion values, and also the schema will not be exported to Ads. - "name": "A String", # Output only. Resource name of the schema. This will be child of ONLY an iOS stream, and there can be at most one such child under an iOS stream. Format: properties/{property}/dataStreams/{dataStream}/sKAdNetworkConversionValueSchema + "name": "A String", # Identifier. Resource name of the schema. This will be child of ONLY an iOS stream, and there can be at most one such child under an iOS stream. Format: properties/{property}/dataStreams/{dataStream}/sKAdNetworkConversionValueSchema "postbackWindowOne": { # Settings for a SKAdNetwork conversion postback window. # Required. The conversion value settings for the first postback window. These differ from values for postback window two and three in that they contain a "Fine" grained conversion value (a numeric value). Conversion values for this postback window must be set. The other windows are optional and may inherit this window's settings if unset or disabled. "conversionValues": [ # Ordering of the repeated field will be used to prioritize the conversion value settings. Lower indexed entries are prioritized higher. The first conversion value setting that evaluates to true will be selected. It must have at least one entry if enable_postback_window_settings is set to true. It can have maximum of 128 entries. { # Conversion value settings for a postback window for SKAdNetwork conversion value schema. diff --git a/docs/dyn/analyticsadmin_v1alpha.properties.calculatedMetrics.html b/docs/dyn/analyticsadmin_v1alpha.properties.calculatedMetrics.html index 4d56763ee5..9484d6bc1a 100644 --- a/docs/dyn/analyticsadmin_v1alpha.properties.calculatedMetrics.html +++ b/docs/dyn/analyticsadmin_v1alpha.properties.calculatedMetrics.html @@ -117,7 +117,7 @@

Method Details

"formula": "A String", # Required. The calculated metric's definition. Maximum number of unique referenced custom metrics is 5. Formulas supports the following operations: + (addition), - (subtraction), - (negative), * (multiplication), / (division), () (parenthesis). Any valid real numbers are acceptable that fit in a Long (64bit integer) or a Double (64 bit floating point number). Example formula: "( customEvent:parameter_name + cartPurchaseQuantity ) / 2.0" "invalidMetricReference": True or False, # Output only. If true, this calculated metric has a invalid metric reference. Anything using a calculated metric with invalid_metric_reference set to true may fail, produce warnings, or produce unexpected results. "metricUnit": "A String", # Required. The type for the calculated metric's value. - "name": "A String", # Output only. Resource name for this CalculatedMetric. Format: 'properties/{property_id}/calculatedMetrics/{calculated_metric_id}' + "name": "A String", # Identifier. Resource name for this CalculatedMetric. Format: 'properties/{property_id}/calculatedMetrics/{calculated_metric_id}' "restrictedMetricType": [ # Output only. Types of restricted data that this metric contains. "A String", ], @@ -139,7 +139,7 @@

Method Details

"formula": "A String", # Required. The calculated metric's definition. Maximum number of unique referenced custom metrics is 5. Formulas supports the following operations: + (addition), - (subtraction), - (negative), * (multiplication), / (division), () (parenthesis). Any valid real numbers are acceptable that fit in a Long (64bit integer) or a Double (64 bit floating point number). Example formula: "( customEvent:parameter_name + cartPurchaseQuantity ) / 2.0" "invalidMetricReference": True or False, # Output only. If true, this calculated metric has a invalid metric reference. Anything using a calculated metric with invalid_metric_reference set to true may fail, produce warnings, or produce unexpected results. "metricUnit": "A String", # Required. The type for the calculated metric's value. - "name": "A String", # Output only. Resource name for this CalculatedMetric. Format: 'properties/{property_id}/calculatedMetrics/{calculated_metric_id}' + "name": "A String", # Identifier. Resource name for this CalculatedMetric. Format: 'properties/{property_id}/calculatedMetrics/{calculated_metric_id}' "restrictedMetricType": [ # Output only. Types of restricted data that this metric contains. "A String", ], @@ -185,7 +185,7 @@

Method Details

"formula": "A String", # Required. The calculated metric's definition. Maximum number of unique referenced custom metrics is 5. Formulas supports the following operations: + (addition), - (subtraction), - (negative), * (multiplication), / (division), () (parenthesis). Any valid real numbers are acceptable that fit in a Long (64bit integer) or a Double (64 bit floating point number). Example formula: "( customEvent:parameter_name + cartPurchaseQuantity ) / 2.0" "invalidMetricReference": True or False, # Output only. If true, this calculated metric has a invalid metric reference. Anything using a calculated metric with invalid_metric_reference set to true may fail, produce warnings, or produce unexpected results. "metricUnit": "A String", # Required. The type for the calculated metric's value. - "name": "A String", # Output only. Resource name for this CalculatedMetric. Format: 'properties/{property_id}/calculatedMetrics/{calculated_metric_id}' + "name": "A String", # Identifier. Resource name for this CalculatedMetric. Format: 'properties/{property_id}/calculatedMetrics/{calculated_metric_id}' "restrictedMetricType": [ # Output only. Types of restricted data that this metric contains. "A String", ], @@ -217,7 +217,7 @@

Method Details

"formula": "A String", # Required. The calculated metric's definition. Maximum number of unique referenced custom metrics is 5. Formulas supports the following operations: + (addition), - (subtraction), - (negative), * (multiplication), / (division), () (parenthesis). Any valid real numbers are acceptable that fit in a Long (64bit integer) or a Double (64 bit floating point number). Example formula: "( customEvent:parameter_name + cartPurchaseQuantity ) / 2.0" "invalidMetricReference": True or False, # Output only. If true, this calculated metric has a invalid metric reference. Anything using a calculated metric with invalid_metric_reference set to true may fail, produce warnings, or produce unexpected results. "metricUnit": "A String", # Required. The type for the calculated metric's value. - "name": "A String", # Output only. Resource name for this CalculatedMetric. Format: 'properties/{property_id}/calculatedMetrics/{calculated_metric_id}' + "name": "A String", # Identifier. Resource name for this CalculatedMetric. Format: 'properties/{property_id}/calculatedMetrics/{calculated_metric_id}' "restrictedMetricType": [ # Output only. Types of restricted data that this metric contains. "A String", ], @@ -246,7 +246,7 @@

Method Details

Updates a CalculatedMetric on a property.
 
 Args:
-  name: string, Output only. Resource name for this CalculatedMetric. Format: 'properties/{property_id}/calculatedMetrics/{calculated_metric_id}' (required)
+  name: string, Identifier. Resource name for this CalculatedMetric. Format: 'properties/{property_id}/calculatedMetrics/{calculated_metric_id}' (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -257,7 +257,7 @@ 

Method Details

"formula": "A String", # Required. The calculated metric's definition. Maximum number of unique referenced custom metrics is 5. Formulas supports the following operations: + (addition), - (subtraction), - (negative), * (multiplication), / (division), () (parenthesis). Any valid real numbers are acceptable that fit in a Long (64bit integer) or a Double (64 bit floating point number). Example formula: "( customEvent:parameter_name + cartPurchaseQuantity ) / 2.0" "invalidMetricReference": True or False, # Output only. If true, this calculated metric has a invalid metric reference. Anything using a calculated metric with invalid_metric_reference set to true may fail, produce warnings, or produce unexpected results. "metricUnit": "A String", # Required. The type for the calculated metric's value. - "name": "A String", # Output only. Resource name for this CalculatedMetric. Format: 'properties/{property_id}/calculatedMetrics/{calculated_metric_id}' + "name": "A String", # Identifier. Resource name for this CalculatedMetric. Format: 'properties/{property_id}/calculatedMetrics/{calculated_metric_id}' "restrictedMetricType": [ # Output only. Types of restricted data that this metric contains. "A String", ], @@ -279,7 +279,7 @@

Method Details

"formula": "A String", # Required. The calculated metric's definition. Maximum number of unique referenced custom metrics is 5. Formulas supports the following operations: + (addition), - (subtraction), - (negative), * (multiplication), / (division), () (parenthesis). Any valid real numbers are acceptable that fit in a Long (64bit integer) or a Double (64 bit floating point number). Example formula: "( customEvent:parameter_name + cartPurchaseQuantity ) / 2.0" "invalidMetricReference": True or False, # Output only. If true, this calculated metric has a invalid metric reference. Anything using a calculated metric with invalid_metric_reference set to true may fail, produce warnings, or produce unexpected results. "metricUnit": "A String", # Required. The type for the calculated metric's value. - "name": "A String", # Output only. Resource name for this CalculatedMetric. Format: 'properties/{property_id}/calculatedMetrics/{calculated_metric_id}' + "name": "A String", # Identifier. Resource name for this CalculatedMetric. Format: 'properties/{property_id}/calculatedMetrics/{calculated_metric_id}' "restrictedMetricType": [ # Output only. Types of restricted data that this metric contains. "A String", ], diff --git a/docs/dyn/analyticsadmin_v1alpha.properties.conversionEvents.html b/docs/dyn/analyticsadmin_v1alpha.properties.conversionEvents.html index 2fe1b64766..73bee4b9ab 100644 --- a/docs/dyn/analyticsadmin_v1alpha.properties.conversionEvents.html +++ b/docs/dyn/analyticsadmin_v1alpha.properties.conversionEvents.html @@ -120,7 +120,7 @@

Method Details

}, "deletable": True or False, # Output only. If set, this event can currently be deleted with DeleteConversionEvent. "eventName": "A String", # Immutable. The event name for this conversion event. Examples: 'click', 'purchase' - "name": "A String", # Output only. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event} + "name": "A String", # Identifier. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event} } x__xgafv: string, V1 error format. @@ -141,7 +141,7 @@

Method Details

}, "deletable": True or False, # Output only. If set, this event can currently be deleted with DeleteConversionEvent. "eventName": "A String", # Immutable. The event name for this conversion event. Examples: 'click', 'purchase' - "name": "A String", # Output only. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event} + "name": "A String", # Identifier. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event} }
@@ -187,7 +187,7 @@

Method Details

}, "deletable": True or False, # Output only. If set, this event can currently be deleted with DeleteConversionEvent. "eventName": "A String", # Immutable. The event name for this conversion event. Examples: 'click', 'purchase' - "name": "A String", # Output only. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event} + "name": "A String", # Identifier. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event} }
@@ -197,8 +197,8 @@

Method Details

Args: parent: string, Required. The resource name of the parent property. Example: 'properties/123' (required) - pageSize: integer, The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum) - pageToken: string, A page token, received from a previous `ListConversionEvents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListConversionEvents` must match the call that provided the page token. + pageSize: integer, Optional. The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum) + pageToken: string, Optional. A page token, received from a previous `ListConversionEvents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListConversionEvents` must match the call that provided the page token. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -219,7 +219,7 @@

Method Details

}, "deletable": True or False, # Output only. If set, this event can currently be deleted with DeleteConversionEvent. "eventName": "A String", # Immutable. The event name for this conversion event. Examples: 'click', 'purchase' - "name": "A String", # Output only. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event} + "name": "A String", # Identifier. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event} }, ], "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. @@ -245,7 +245,7 @@

Method Details

Deprecated: Use `UpdateKeyEvent` instead. Updates a conversion event with the specified attributes.
 
 Args:
-  name: string, Output only. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event} (required)
+  name: string, Identifier. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event} (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -259,7 +259,7 @@ 

Method Details

}, "deletable": True or False, # Output only. If set, this event can currently be deleted with DeleteConversionEvent. "eventName": "A String", # Immutable. The event name for this conversion event. Examples: 'click', 'purchase' - "name": "A String", # Output only. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event} + "name": "A String", # Identifier. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event} } updateMask: string, Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields. @@ -281,7 +281,7 @@

Method Details

}, "deletable": True or False, # Output only. If set, this event can currently be deleted with DeleteConversionEvent. "eventName": "A String", # Immutable. The event name for this conversion event. Examples: 'click', 'purchase' - "name": "A String", # Output only. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event} + "name": "A String", # Identifier. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event} }
diff --git a/docs/dyn/analyticsadmin_v1alpha.properties.customDimensions.html b/docs/dyn/analyticsadmin_v1alpha.properties.customDimensions.html index 68c17b8166..07b5f56d24 100644 --- a/docs/dyn/analyticsadmin_v1alpha.properties.customDimensions.html +++ b/docs/dyn/analyticsadmin_v1alpha.properties.customDimensions.html @@ -138,7 +138,7 @@

Method Details

"description": "A String", # Optional. Description for this custom dimension. Max length of 150 characters. "disallowAdsPersonalization": True or False, # Optional. If set to true, sets this dimension as NPA and excludes it from ads personalization. This is currently only supported by user-scoped custom dimensions. "displayName": "A String", # Required. Display name for this custom dimension as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets. - "name": "A String", # Output only. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension} + "name": "A String", # Identifier. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension} "parameterName": "A String", # Required. Immutable. Tagging parameter name for this custom dimension. If this is a user-scoped dimension, then this is the user property name. If this is an event-scoped dimension, then this is the event parameter name. If this is an item-scoped dimension, then this is the parameter name found in the eCommerce items array. May only contain alphanumeric and underscore characters, starting with a letter. Max length of 24 characters for user-scoped dimensions, 40 characters for event-scoped dimensions. "scope": "A String", # Required. Immutable. The scope of this dimension. } @@ -155,7 +155,7 @@

Method Details

"description": "A String", # Optional. Description for this custom dimension. Max length of 150 characters. "disallowAdsPersonalization": True or False, # Optional. If set to true, sets this dimension as NPA and excludes it from ads personalization. This is currently only supported by user-scoped custom dimensions. "displayName": "A String", # Required. Display name for this custom dimension as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets. - "name": "A String", # Output only. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension} + "name": "A String", # Identifier. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension} "parameterName": "A String", # Required. Immutable. Tagging parameter name for this custom dimension. If this is a user-scoped dimension, then this is the user property name. If this is an event-scoped dimension, then this is the event parameter name. If this is an item-scoped dimension, then this is the parameter name found in the eCommerce items array. May only contain alphanumeric and underscore characters, starting with a letter. Max length of 24 characters for user-scoped dimensions, 40 characters for event-scoped dimensions. "scope": "A String", # Required. Immutable. The scope of this dimension. }
@@ -179,7 +179,7 @@

Method Details

"description": "A String", # Optional. Description for this custom dimension. Max length of 150 characters. "disallowAdsPersonalization": True or False, # Optional. If set to true, sets this dimension as NPA and excludes it from ads personalization. This is currently only supported by user-scoped custom dimensions. "displayName": "A String", # Required. Display name for this custom dimension as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets. - "name": "A String", # Output only. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension} + "name": "A String", # Identifier. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension} "parameterName": "A String", # Required. Immutable. Tagging parameter name for this custom dimension. If this is a user-scoped dimension, then this is the user property name. If this is an event-scoped dimension, then this is the event parameter name. If this is an item-scoped dimension, then this is the parameter name found in the eCommerce items array. May only contain alphanumeric and underscore characters, starting with a letter. Max length of 24 characters for user-scoped dimensions, 40 characters for event-scoped dimensions. "scope": "A String", # Required. Immutable. The scope of this dimension. }
@@ -191,8 +191,8 @@

Method Details

Args: parent: string, Required. Example format: properties/1234 (required) - pageSize: integer, The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum). - pageToken: string, A page token, received from a previous `ListCustomDimensions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCustomDimensions` must match the call that provided the page token. + pageSize: integer, Optional. The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum). + pageToken: string, Optional. A page token, received from a previous `ListCustomDimensions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCustomDimensions` must match the call that provided the page token. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -207,7 +207,7 @@

Method Details

"description": "A String", # Optional. Description for this custom dimension. Max length of 150 characters. "disallowAdsPersonalization": True or False, # Optional. If set to true, sets this dimension as NPA and excludes it from ads personalization. This is currently only supported by user-scoped custom dimensions. "displayName": "A String", # Required. Display name for this custom dimension as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets. - "name": "A String", # Output only. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension} + "name": "A String", # Identifier. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension} "parameterName": "A String", # Required. Immutable. Tagging parameter name for this custom dimension. If this is a user-scoped dimension, then this is the user property name. If this is an event-scoped dimension, then this is the event parameter name. If this is an item-scoped dimension, then this is the parameter name found in the eCommerce items array. May only contain alphanumeric and underscore characters, starting with a letter. Max length of 24 characters for user-scoped dimensions, 40 characters for event-scoped dimensions. "scope": "A String", # Required. Immutable. The scope of this dimension. }, @@ -235,7 +235,7 @@

Method Details

Updates a CustomDimension on a property.
 
 Args:
-  name: string, Output only. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension} (required)
+  name: string, Identifier. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension} (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -243,7 +243,7 @@ 

Method Details

"description": "A String", # Optional. Description for this custom dimension. Max length of 150 characters. "disallowAdsPersonalization": True or False, # Optional. If set to true, sets this dimension as NPA and excludes it from ads personalization. This is currently only supported by user-scoped custom dimensions. "displayName": "A String", # Required. Display name for this custom dimension as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets. - "name": "A String", # Output only. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension} + "name": "A String", # Identifier. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension} "parameterName": "A String", # Required. Immutable. Tagging parameter name for this custom dimension. If this is a user-scoped dimension, then this is the user property name. If this is an event-scoped dimension, then this is the event parameter name. If this is an item-scoped dimension, then this is the parameter name found in the eCommerce items array. May only contain alphanumeric and underscore characters, starting with a letter. Max length of 24 characters for user-scoped dimensions, 40 characters for event-scoped dimensions. "scope": "A String", # Required. Immutable. The scope of this dimension. } @@ -261,7 +261,7 @@

Method Details

"description": "A String", # Optional. Description for this custom dimension. Max length of 150 characters. "disallowAdsPersonalization": True or False, # Optional. If set to true, sets this dimension as NPA and excludes it from ads personalization. This is currently only supported by user-scoped custom dimensions. "displayName": "A String", # Required. Display name for this custom dimension as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets. - "name": "A String", # Output only. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension} + "name": "A String", # Identifier. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension} "parameterName": "A String", # Required. Immutable. Tagging parameter name for this custom dimension. If this is a user-scoped dimension, then this is the user property name. If this is an event-scoped dimension, then this is the event parameter name. If this is an item-scoped dimension, then this is the parameter name found in the eCommerce items array. May only contain alphanumeric and underscore characters, starting with a letter. Max length of 24 characters for user-scoped dimensions, 40 characters for event-scoped dimensions. "scope": "A String", # Required. Immutable. The scope of this dimension. }
diff --git a/docs/dyn/analyticsadmin_v1alpha.properties.customMetrics.html b/docs/dyn/analyticsadmin_v1alpha.properties.customMetrics.html index 292f762ac0..9082599b60 100644 --- a/docs/dyn/analyticsadmin_v1alpha.properties.customMetrics.html +++ b/docs/dyn/analyticsadmin_v1alpha.properties.customMetrics.html @@ -138,7 +138,7 @@

Method Details

"description": "A String", # Optional. Description for this custom dimension. Max length of 150 characters. "displayName": "A String", # Required. Display name for this custom metric as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets. "measurementUnit": "A String", # Required. The type for the custom metric's value. - "name": "A String", # Output only. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric} + "name": "A String", # Identifier. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric} "parameterName": "A String", # Required. Immutable. Tagging name for this custom metric. If this is an event-scoped metric, then this is the event parameter name. May only contain alphanumeric and underscore charactes, starting with a letter. Max length of 40 characters for event-scoped metrics. "restrictedMetricType": [ # Optional. Types of restricted data that this metric may contain. Required for metrics with CURRENCY measurement unit. Must be empty for metrics with a non-CURRENCY measurement unit. "A String", @@ -158,7 +158,7 @@

Method Details

"description": "A String", # Optional. Description for this custom dimension. Max length of 150 characters. "displayName": "A String", # Required. Display name for this custom metric as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets. "measurementUnit": "A String", # Required. The type for the custom metric's value. - "name": "A String", # Output only. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric} + "name": "A String", # Identifier. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric} "parameterName": "A String", # Required. Immutable. Tagging name for this custom metric. If this is an event-scoped metric, then this is the event parameter name. May only contain alphanumeric and underscore charactes, starting with a letter. Max length of 40 characters for event-scoped metrics. "restrictedMetricType": [ # Optional. Types of restricted data that this metric may contain. Required for metrics with CURRENCY measurement unit. Must be empty for metrics with a non-CURRENCY measurement unit. "A String", @@ -185,7 +185,7 @@

Method Details

"description": "A String", # Optional. Description for this custom dimension. Max length of 150 characters. "displayName": "A String", # Required. Display name for this custom metric as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets. "measurementUnit": "A String", # Required. The type for the custom metric's value. - "name": "A String", # Output only. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric} + "name": "A String", # Identifier. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric} "parameterName": "A String", # Required. Immutable. Tagging name for this custom metric. If this is an event-scoped metric, then this is the event parameter name. May only contain alphanumeric and underscore charactes, starting with a letter. Max length of 40 characters for event-scoped metrics. "restrictedMetricType": [ # Optional. Types of restricted data that this metric may contain. Required for metrics with CURRENCY measurement unit. Must be empty for metrics with a non-CURRENCY measurement unit. "A String", @@ -216,7 +216,7 @@

Method Details

"description": "A String", # Optional. Description for this custom dimension. Max length of 150 characters. "displayName": "A String", # Required. Display name for this custom metric as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets. "measurementUnit": "A String", # Required. The type for the custom metric's value. - "name": "A String", # Output only. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric} + "name": "A String", # Identifier. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric} "parameterName": "A String", # Required. Immutable. Tagging name for this custom metric. If this is an event-scoped metric, then this is the event parameter name. May only contain alphanumeric and underscore charactes, starting with a letter. Max length of 40 characters for event-scoped metrics. "restrictedMetricType": [ # Optional. Types of restricted data that this metric may contain. Required for metrics with CURRENCY measurement unit. Must be empty for metrics with a non-CURRENCY measurement unit. "A String", @@ -247,7 +247,7 @@

Method Details

Updates a CustomMetric on a property.
 
 Args:
-  name: string, Output only. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric} (required)
+  name: string, Identifier. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric} (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -255,7 +255,7 @@ 

Method Details

"description": "A String", # Optional. Description for this custom dimension. Max length of 150 characters. "displayName": "A String", # Required. Display name for this custom metric as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets. "measurementUnit": "A String", # Required. The type for the custom metric's value. - "name": "A String", # Output only. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric} + "name": "A String", # Identifier. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric} "parameterName": "A String", # Required. Immutable. Tagging name for this custom metric. If this is an event-scoped metric, then this is the event parameter name. May only contain alphanumeric and underscore charactes, starting with a letter. Max length of 40 characters for event-scoped metrics. "restrictedMetricType": [ # Optional. Types of restricted data that this metric may contain. Required for metrics with CURRENCY measurement unit. Must be empty for metrics with a non-CURRENCY measurement unit. "A String", @@ -276,7 +276,7 @@

Method Details

"description": "A String", # Optional. Description for this custom dimension. Max length of 150 characters. "displayName": "A String", # Required. Display name for this custom metric as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets. "measurementUnit": "A String", # Required. The type for the custom metric's value. - "name": "A String", # Output only. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric} + "name": "A String", # Identifier. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric} "parameterName": "A String", # Required. Immutable. Tagging name for this custom metric. If this is an event-scoped metric, then this is the event parameter name. May only contain alphanumeric and underscore charactes, starting with a letter. Max length of 40 characters for event-scoped metrics. "restrictedMetricType": [ # Optional. Types of restricted data that this metric may contain. Required for metrics with CURRENCY measurement unit. Must be empty for metrics with a non-CURRENCY measurement unit. "A String", diff --git a/docs/dyn/analyticsadmin_v1alpha.properties.dataStreams.html b/docs/dyn/analyticsadmin_v1alpha.properties.dataStreams.html index 93a55c8b8b..ae55dff8ad 100644 --- a/docs/dyn/analyticsadmin_v1alpha.properties.dataStreams.html +++ b/docs/dyn/analyticsadmin_v1alpha.properties.dataStreams.html @@ -156,7 +156,7 @@

Method Details

"bundleId": "A String", # Required. Immutable. The Apple App Store Bundle ID for the app Example: "com.example.myiosapp" "firebaseAppId": "A String", # Output only. ID of the corresponding iOS app in Firebase, if any. This ID can change if the iOS app is deleted and recreated. }, - "name": "A String", # Output only. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: "properties/1000/dataStreams/2000" + "name": "A String", # Identifier. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: "properties/1000/dataStreams/2000" "type": "A String", # Required. Immutable. The type of this DataStream resource. "updateTime": "A String", # Output only. Time when stream payload fields were last updated. "webStreamData": { # Data specific to web streams. # Data specific to web streams. Must be populated if type is WEB_DATA_STREAM. @@ -185,7 +185,7 @@

Method Details

"bundleId": "A String", # Required. Immutable. The Apple App Store Bundle ID for the app Example: "com.example.myiosapp" "firebaseAppId": "A String", # Output only. ID of the corresponding iOS app in Firebase, if any. This ID can change if the iOS app is deleted and recreated. }, - "name": "A String", # Output only. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: "properties/1000/dataStreams/2000" + "name": "A String", # Identifier. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: "properties/1000/dataStreams/2000" "type": "A String", # Required. Immutable. The type of this DataStream resource. "updateTime": "A String", # Output only. Time when stream payload fields were last updated. "webStreamData": { # Data specific to web streams. # Data specific to web streams. Must be populated if type is WEB_DATA_STREAM. @@ -239,7 +239,7 @@

Method Details

"bundleId": "A String", # Required. Immutable. The Apple App Store Bundle ID for the app Example: "com.example.myiosapp" "firebaseAppId": "A String", # Output only. ID of the corresponding iOS app in Firebase, if any. This ID can change if the iOS app is deleted and recreated. }, - "name": "A String", # Output only. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: "properties/1000/dataStreams/2000" + "name": "A String", # Identifier. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: "properties/1000/dataStreams/2000" "type": "A String", # Required. Immutable. The type of this DataStream resource. "updateTime": "A String", # Output only. Time when stream payload fields were last updated. "webStreamData": { # Data specific to web streams. # Data specific to web streams. Must be populated if type is WEB_DATA_STREAM. @@ -318,7 +318,7 @@

Method Details

An object of the form: { # Read-only resource with the tag for sending data from a website to a DataStream. Only present for web DataStream resources. - "name": "A String", # Output only. Resource name for this GlobalSiteTag resource. Format: properties/{property_id}/dataStreams/{stream_id}/globalSiteTag Example: "properties/123/dataStreams/456/globalSiteTag" + "name": "A String", # Identifier. Resource name for this GlobalSiteTag resource. Format: properties/{property_id}/dataStreams/{stream_id}/globalSiteTag Example: "properties/123/dataStreams/456/globalSiteTag" "snippet": "A String", # Immutable. JavaScript code snippet to be pasted as the first item into the head tag of every webpage to measure. }
@@ -352,7 +352,7 @@

Method Details

"bundleId": "A String", # Required. Immutable. The Apple App Store Bundle ID for the app Example: "com.example.myiosapp" "firebaseAppId": "A String", # Output only. ID of the corresponding iOS app in Firebase, if any. This ID can change if the iOS app is deleted and recreated. }, - "name": "A String", # Output only. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: "properties/1000/dataStreams/2000" + "name": "A String", # Identifier. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: "properties/1000/dataStreams/2000" "type": "A String", # Required. Immutable. The type of this DataStream resource. "updateTime": "A String", # Output only. Time when stream payload fields were last updated. "webStreamData": { # Data specific to web streams. # Data specific to web streams. Must be populated if type is WEB_DATA_STREAM. @@ -385,7 +385,7 @@

Method Details

Updates a DataStream on a property.
 
 Args:
-  name: string, Output only. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: "properties/1000/dataStreams/2000" (required)
+  name: string, Identifier. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: "properties/1000/dataStreams/2000" (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -400,7 +400,7 @@ 

Method Details

"bundleId": "A String", # Required. Immutable. The Apple App Store Bundle ID for the app Example: "com.example.myiosapp" "firebaseAppId": "A String", # Output only. ID of the corresponding iOS app in Firebase, if any. This ID can change if the iOS app is deleted and recreated. }, - "name": "A String", # Output only. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: "properties/1000/dataStreams/2000" + "name": "A String", # Identifier. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: "properties/1000/dataStreams/2000" "type": "A String", # Required. Immutable. The type of this DataStream resource. "updateTime": "A String", # Output only. Time when stream payload fields were last updated. "webStreamData": { # Data specific to web streams. # Data specific to web streams. Must be populated if type is WEB_DATA_STREAM. @@ -430,7 +430,7 @@

Method Details

"bundleId": "A String", # Required. Immutable. The Apple App Store Bundle ID for the app Example: "com.example.myiosapp" "firebaseAppId": "A String", # Output only. ID of the corresponding iOS app in Firebase, if any. This ID can change if the iOS app is deleted and recreated. }, - "name": "A String", # Output only. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: "properties/1000/dataStreams/2000" + "name": "A String", # Identifier. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: "properties/1000/dataStreams/2000" "type": "A String", # Required. Immutable. The type of this DataStream resource. "updateTime": "A String", # Output only. Time when stream payload fields were last updated. "webStreamData": { # Data specific to web streams. # Data specific to web streams. Must be populated if type is WEB_DATA_STREAM. diff --git a/docs/dyn/analyticsadmin_v1alpha.properties.dataStreams.measurementProtocolSecrets.html b/docs/dyn/analyticsadmin_v1alpha.properties.dataStreams.measurementProtocolSecrets.html index 830df83c6d..5e883a5a43 100644 --- a/docs/dyn/analyticsadmin_v1alpha.properties.dataStreams.measurementProtocolSecrets.html +++ b/docs/dyn/analyticsadmin_v1alpha.properties.dataStreams.measurementProtocolSecrets.html @@ -112,7 +112,7 @@

Method Details

{ # A secret value used for sending hits to Measurement Protocol. "displayName": "A String", # Required. Human-readable display name for this secret. - "name": "A String", # Output only. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret} + "name": "A String", # Identifier. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret} "secretValue": "A String", # Output only. The measurement protocol secret value. Pass this value to the api_secret field of the Measurement Protocol API when sending hits to this secret's parent property. } @@ -126,7 +126,7 @@

Method Details

{ # A secret value used for sending hits to Measurement Protocol. "displayName": "A String", # Required. Human-readable display name for this secret. - "name": "A String", # Output only. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret} + "name": "A String", # Identifier. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret} "secretValue": "A String", # Output only. The measurement protocol secret value. Pass this value to the api_secret field of the Measurement Protocol API when sending hits to this secret's parent property. }
@@ -165,7 +165,7 @@

Method Details

{ # A secret value used for sending hits to Measurement Protocol. "displayName": "A String", # Required. Human-readable display name for this secret. - "name": "A String", # Output only. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret} + "name": "A String", # Identifier. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret} "secretValue": "A String", # Output only. The measurement protocol secret value. Pass this value to the api_secret field of the Measurement Protocol API when sending hits to this secret's parent property. }
@@ -176,8 +176,8 @@

Method Details

Args: parent: string, Required. The resource name of the parent stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets (required) - pageSize: integer, The maximum number of resources to return. If unspecified, at most 10 resources will be returned. The maximum value is 10. Higher values will be coerced to the maximum. - pageToken: string, A page token, received from a previous `ListMeasurementProtocolSecrets` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListMeasurementProtocolSecrets` must match the call that provided the page token. + pageSize: integer, Optional. The maximum number of resources to return. If unspecified, at most 10 resources will be returned. The maximum value is 10. Higher values will be coerced to the maximum. + pageToken: string, Optional. A page token, received from a previous `ListMeasurementProtocolSecrets` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListMeasurementProtocolSecrets` must match the call that provided the page token. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -190,7 +190,7 @@

Method Details

"measurementProtocolSecrets": [ # A list of secrets for the parent stream specified in the request. { # A secret value used for sending hits to Measurement Protocol. "displayName": "A String", # Required. Human-readable display name for this secret. - "name": "A String", # Output only. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret} + "name": "A String", # Identifier. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret} "secretValue": "A String", # Output only. The measurement protocol secret value. Pass this value to the api_secret field of the Measurement Protocol API when sending hits to this secret's parent property. }, ], @@ -217,13 +217,13 @@

Method Details

Updates a measurement protocol secret.
 
 Args:
-  name: string, Output only. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret} (required)
+  name: string, Identifier. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret} (required)
   body: object, The request body.
     The object takes the form of:
 
 { # A secret value used for sending hits to Measurement Protocol.
   "displayName": "A String", # Required. Human-readable display name for this secret.
-  "name": "A String", # Output only. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}
+  "name": "A String", # Identifier. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}
   "secretValue": "A String", # Output only. The measurement protocol secret value. Pass this value to the api_secret field of the Measurement Protocol API when sending hits to this secret's parent property.
 }
 
@@ -238,7 +238,7 @@ 

Method Details

{ # A secret value used for sending hits to Measurement Protocol. "displayName": "A String", # Required. Human-readable display name for this secret. - "name": "A String", # Output only. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret} + "name": "A String", # Identifier. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret} "secretValue": "A String", # Output only. The measurement protocol secret value. Pass this value to the api_secret field of the Measurement Protocol API when sending hits to this secret's parent property. }
diff --git a/docs/dyn/analyticsadmin_v1alpha.properties.dataStreams.sKAdNetworkConversionValueSchema.html b/docs/dyn/analyticsadmin_v1alpha.properties.dataStreams.sKAdNetworkConversionValueSchema.html index 34515f5e83..02d04e6e20 100644 --- a/docs/dyn/analyticsadmin_v1alpha.properties.dataStreams.sKAdNetworkConversionValueSchema.html +++ b/docs/dyn/analyticsadmin_v1alpha.properties.dataStreams.sKAdNetworkConversionValueSchema.html @@ -112,7 +112,7 @@

Method Details

{ # SKAdNetwork conversion value schema of an iOS stream. "applyConversionValues": True or False, # If enabled, the GA SDK will set conversion values using this schema definition, and schema will be exported to any Google Ads accounts linked to this property. If disabled, the GA SDK will not automatically set conversion values, and also the schema will not be exported to Ads. - "name": "A String", # Output only. Resource name of the schema. This will be child of ONLY an iOS stream, and there can be at most one such child under an iOS stream. Format: properties/{property}/dataStreams/{dataStream}/sKAdNetworkConversionValueSchema + "name": "A String", # Identifier. Resource name of the schema. This will be child of ONLY an iOS stream, and there can be at most one such child under an iOS stream. Format: properties/{property}/dataStreams/{dataStream}/sKAdNetworkConversionValueSchema "postbackWindowOne": { # Settings for a SKAdNetwork conversion postback window. # Required. The conversion value settings for the first postback window. These differ from values for postback window two and three in that they contain a "Fine" grained conversion value (a numeric value). Conversion values for this postback window must be set. The other windows are optional and may inherit this window's settings if unset or disabled. "conversionValues": [ # Ordering of the repeated field will be used to prioritize the conversion value settings. Lower indexed entries are prioritized higher. The first conversion value setting that evaluates to true will be selected. It must have at least one entry if enable_postback_window_settings is set to true. It can have maximum of 128 entries. { # Conversion value settings for a postback window for SKAdNetwork conversion value schema. @@ -185,7 +185,7 @@

Method Details

{ # SKAdNetwork conversion value schema of an iOS stream. "applyConversionValues": True or False, # If enabled, the GA SDK will set conversion values using this schema definition, and schema will be exported to any Google Ads accounts linked to this property. If disabled, the GA SDK will not automatically set conversion values, and also the schema will not be exported to Ads. - "name": "A String", # Output only. Resource name of the schema. This will be child of ONLY an iOS stream, and there can be at most one such child under an iOS stream. Format: properties/{property}/dataStreams/{dataStream}/sKAdNetworkConversionValueSchema + "name": "A String", # Identifier. Resource name of the schema. This will be child of ONLY an iOS stream, and there can be at most one such child under an iOS stream. Format: properties/{property}/dataStreams/{dataStream}/sKAdNetworkConversionValueSchema "postbackWindowOne": { # Settings for a SKAdNetwork conversion postback window. # Required. The conversion value settings for the first postback window. These differ from values for postback window two and three in that they contain a "Fine" grained conversion value (a numeric value). Conversion values for this postback window must be set. The other windows are optional and may inherit this window's settings if unset or disabled. "conversionValues": [ # Ordering of the repeated field will be used to prioritize the conversion value settings. Lower indexed entries are prioritized higher. The first conversion value setting that evaluates to true will be selected. It must have at least one entry if enable_postback_window_settings is set to true. It can have maximum of 128 entries. { # Conversion value settings for a postback window for SKAdNetwork conversion value schema. @@ -283,7 +283,7 @@

Method Details

{ # SKAdNetwork conversion value schema of an iOS stream. "applyConversionValues": True or False, # If enabled, the GA SDK will set conversion values using this schema definition, and schema will be exported to any Google Ads accounts linked to this property. If disabled, the GA SDK will not automatically set conversion values, and also the schema will not be exported to Ads. - "name": "A String", # Output only. Resource name of the schema. This will be child of ONLY an iOS stream, and there can be at most one such child under an iOS stream. Format: properties/{property}/dataStreams/{dataStream}/sKAdNetworkConversionValueSchema + "name": "A String", # Identifier. Resource name of the schema. This will be child of ONLY an iOS stream, and there can be at most one such child under an iOS stream. Format: properties/{property}/dataStreams/{dataStream}/sKAdNetworkConversionValueSchema "postbackWindowOne": { # Settings for a SKAdNetwork conversion postback window. # Required. The conversion value settings for the first postback window. These differ from values for postback window two and three in that they contain a "Fine" grained conversion value (a numeric value). Conversion values for this postback window must be set. The other windows are optional and may inherit this window's settings if unset or disabled. "conversionValues": [ # Ordering of the repeated field will be used to prioritize the conversion value settings. Lower indexed entries are prioritized higher. The first conversion value setting that evaluates to true will be selected. It must have at least one entry if enable_postback_window_settings is set to true. It can have maximum of 128 entries. { # Conversion value settings for a postback window for SKAdNetwork conversion value schema. @@ -353,8 +353,8 @@

Method Details

Args: parent: string, Required. The DataStream resource to list schemas for. Format: properties/{property_id}/dataStreams/{dataStream} Example: properties/1234/dataStreams/5678 (required) - pageSize: integer, The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum) - pageToken: string, A page token, received from a previous `ListSKAdNetworkConversionValueSchemas` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSKAdNetworkConversionValueSchema` must match the call that provided the page token. + pageSize: integer, Optional. The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum) + pageToken: string, Optional. A page token, received from a previous `ListSKAdNetworkConversionValueSchemas` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSKAdNetworkConversionValueSchema` must match the call that provided the page token. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -368,7 +368,7 @@

Method Details

"skadnetworkConversionValueSchemas": [ # List of SKAdNetworkConversionValueSchemas. This will have at most one value. { # SKAdNetwork conversion value schema of an iOS stream. "applyConversionValues": True or False, # If enabled, the GA SDK will set conversion values using this schema definition, and schema will be exported to any Google Ads accounts linked to this property. If disabled, the GA SDK will not automatically set conversion values, and also the schema will not be exported to Ads. - "name": "A String", # Output only. Resource name of the schema. This will be child of ONLY an iOS stream, and there can be at most one such child under an iOS stream. Format: properties/{property}/dataStreams/{dataStream}/sKAdNetworkConversionValueSchema + "name": "A String", # Identifier. Resource name of the schema. This will be child of ONLY an iOS stream, and there can be at most one such child under an iOS stream. Format: properties/{property}/dataStreams/{dataStream}/sKAdNetworkConversionValueSchema "postbackWindowOne": { # Settings for a SKAdNetwork conversion postback window. # Required. The conversion value settings for the first postback window. These differ from values for postback window two and three in that they contain a "Fine" grained conversion value (a numeric value). Conversion values for this postback window must be set. The other windows are optional and may inherit this window's settings if unset or disabled. "conversionValues": [ # Ordering of the repeated field will be used to prioritize the conversion value settings. Lower indexed entries are prioritized higher. The first conversion value setting that evaluates to true will be selected. It must have at least one entry if enable_postback_window_settings is set to true. It can have maximum of 128 entries. { # Conversion value settings for a postback window for SKAdNetwork conversion value schema. @@ -453,13 +453,13 @@

Method Details

Updates a SKAdNetworkConversionValueSchema.
 
 Args:
-  name: string, Output only. Resource name of the schema. This will be child of ONLY an iOS stream, and there can be at most one such child under an iOS stream. Format: properties/{property}/dataStreams/{dataStream}/sKAdNetworkConversionValueSchema (required)
+  name: string, Identifier. Resource name of the schema. This will be child of ONLY an iOS stream, and there can be at most one such child under an iOS stream. Format: properties/{property}/dataStreams/{dataStream}/sKAdNetworkConversionValueSchema (required)
   body: object, The request body.
     The object takes the form of:
 
 { # SKAdNetwork conversion value schema of an iOS stream.
   "applyConversionValues": True or False, # If enabled, the GA SDK will set conversion values using this schema definition, and schema will be exported to any Google Ads accounts linked to this property. If disabled, the GA SDK will not automatically set conversion values, and also the schema will not be exported to Ads.
-  "name": "A String", # Output only. Resource name of the schema. This will be child of ONLY an iOS stream, and there can be at most one such child under an iOS stream. Format: properties/{property}/dataStreams/{dataStream}/sKAdNetworkConversionValueSchema
+  "name": "A String", # Identifier. Resource name of the schema. This will be child of ONLY an iOS stream, and there can be at most one such child under an iOS stream. Format: properties/{property}/dataStreams/{dataStream}/sKAdNetworkConversionValueSchema
   "postbackWindowOne": { # Settings for a SKAdNetwork conversion postback window. # Required. The conversion value settings for the first postback window. These differ from values for postback window two and three in that they contain a "Fine" grained conversion value (a numeric value). Conversion values for this postback window must be set. The other windows are optional and may inherit this window's settings if unset or disabled.
     "conversionValues": [ # Ordering of the repeated field will be used to prioritize the conversion value settings. Lower indexed entries are prioritized higher. The first conversion value setting that evaluates to true will be selected. It must have at least one entry if enable_postback_window_settings is set to true. It can have maximum of 128 entries.
       { # Conversion value settings for a postback window for SKAdNetwork conversion value schema.
@@ -533,7 +533,7 @@ 

Method Details

{ # SKAdNetwork conversion value schema of an iOS stream. "applyConversionValues": True or False, # If enabled, the GA SDK will set conversion values using this schema definition, and schema will be exported to any Google Ads accounts linked to this property. If disabled, the GA SDK will not automatically set conversion values, and also the schema will not be exported to Ads. - "name": "A String", # Output only. Resource name of the schema. This will be child of ONLY an iOS stream, and there can be at most one such child under an iOS stream. Format: properties/{property}/dataStreams/{dataStream}/sKAdNetworkConversionValueSchema + "name": "A String", # Identifier. Resource name of the schema. This will be child of ONLY an iOS stream, and there can be at most one such child under an iOS stream. Format: properties/{property}/dataStreams/{dataStream}/sKAdNetworkConversionValueSchema "postbackWindowOne": { # Settings for a SKAdNetwork conversion postback window. # Required. The conversion value settings for the first postback window. These differ from values for postback window two and three in that they contain a "Fine" grained conversion value (a numeric value). Conversion values for this postback window must be set. The other windows are optional and may inherit this window's settings if unset or disabled. "conversionValues": [ # Ordering of the repeated field will be used to prioritize the conversion value settings. Lower indexed entries are prioritized higher. The first conversion value setting that evaluates to true will be selected. It must have at least one entry if enable_postback_window_settings is set to true. It can have maximum of 128 entries. { # Conversion value settings for a postback window for SKAdNetwork conversion value schema. diff --git a/docs/dyn/analyticsadmin_v1alpha.properties.displayVideo360AdvertiserLinkProposals.html b/docs/dyn/analyticsadmin_v1alpha.properties.displayVideo360AdvertiserLinkProposals.html index 4a70cf341b..622032957a 100644 --- a/docs/dyn/analyticsadmin_v1alpha.properties.displayVideo360AdvertiserLinkProposals.html +++ b/docs/dyn/analyticsadmin_v1alpha.properties.displayVideo360AdvertiserLinkProposals.html @@ -126,7 +126,7 @@

Method Details

"advertiserId": "A String", # Immutable. The Display & Video 360 Advertiser's advertiser ID. "campaignDataSharingEnabled": True or False, # Immutable. Enables the import of campaign data from Display & Video 360 into the Google Analytics property. After link creation, this can only be updated from the Display & Video 360 product. If this field is not set on create, it will be defaulted to true. "costDataSharingEnabled": True or False, # Immutable. Enables the import of cost data from Display & Video 360 into the Google Analytics property. This can only be enabled if `campaign_data_sharing_enabled` is true. After link creation, this can only be updated from the Display & Video 360 product. If this field is not set on create, it will be defaulted to true. - "name": "A String", # Output only. The resource name for this DisplayVideo360AdvertiserLink resource. Format: properties/{propertyId}/displayVideo360AdvertiserLinks/{linkId} Note: linkId is not the Display & Video 360 Advertiser ID + "name": "A String", # Identifier. The resource name for this DisplayVideo360AdvertiserLink resource. Format: properties/{propertyId}/displayVideo360AdvertiserLinks/{linkId} Note: linkId is not the Display & Video 360 Advertiser ID }, }
@@ -162,7 +162,7 @@

Method Details

"linkProposalState": "A String", # Output only. The state of this proposal. "requestorEmail": "A String", # Output only. The email address of the user that proposed this linkage. }, - "name": "A String", # Output only. The resource name for this DisplayVideo360AdvertiserLinkProposal resource. Format: properties/{propertyId}/displayVideo360AdvertiserLinkProposals/{proposalId} Note: proposalId is not the Display & Video 360 Advertiser ID + "name": "A String", # Identifier. The resource name for this DisplayVideo360AdvertiserLinkProposal resource. Format: properties/{propertyId}/displayVideo360AdvertiserLinkProposals/{proposalId} Note: proposalId is not the Display & Video 360 Advertiser ID "validationEmail": "A String", # Input only. On a proposal being sent to Display & Video 360, this field must be set to the email address of an admin on the target advertiser. This is used to verify that the Google Analytics admin is aware of at least one admin on the Display & Video 360 Advertiser. This does not restrict approval of the proposal to a single user. Any admin on the Display & Video 360 Advertiser may approve the proposal. }
@@ -192,7 +192,7 @@

Method Details

"linkProposalState": "A String", # Output only. The state of this proposal. "requestorEmail": "A String", # Output only. The email address of the user that proposed this linkage. }, - "name": "A String", # Output only. The resource name for this DisplayVideo360AdvertiserLinkProposal resource. Format: properties/{propertyId}/displayVideo360AdvertiserLinkProposals/{proposalId} Note: proposalId is not the Display & Video 360 Advertiser ID + "name": "A String", # Identifier. The resource name for this DisplayVideo360AdvertiserLinkProposal resource. Format: properties/{propertyId}/displayVideo360AdvertiserLinkProposals/{proposalId} Note: proposalId is not the Display & Video 360 Advertiser ID "validationEmail": "A String", # Input only. On a proposal being sent to Display & Video 360, this field must be set to the email address of an admin on the target advertiser. This is used to verify that the Google Analytics admin is aware of at least one admin on the Display & Video 360 Advertiser. This does not restrict approval of the proposal to a single user. Any admin on the Display & Video 360 Advertiser may approve the proposal. } @@ -215,7 +215,7 @@

Method Details

"linkProposalState": "A String", # Output only. The state of this proposal. "requestorEmail": "A String", # Output only. The email address of the user that proposed this linkage. }, - "name": "A String", # Output only. The resource name for this DisplayVideo360AdvertiserLinkProposal resource. Format: properties/{propertyId}/displayVideo360AdvertiserLinkProposals/{proposalId} Note: proposalId is not the Display & Video 360 Advertiser ID + "name": "A String", # Identifier. The resource name for this DisplayVideo360AdvertiserLinkProposal resource. Format: properties/{propertyId}/displayVideo360AdvertiserLinkProposals/{proposalId} Note: proposalId is not the Display & Video 360 Advertiser ID "validationEmail": "A String", # Input only. On a proposal being sent to Display & Video 360, this field must be set to the email address of an admin on the target advertiser. This is used to verify that the Google Analytics admin is aware of at least one admin on the Display & Video 360 Advertiser. This does not restrict approval of the proposal to a single user. Any admin on the Display & Video 360 Advertiser may approve the proposal. }
@@ -263,7 +263,7 @@

Method Details

"linkProposalState": "A String", # Output only. The state of this proposal. "requestorEmail": "A String", # Output only. The email address of the user that proposed this linkage. }, - "name": "A String", # Output only. The resource name for this DisplayVideo360AdvertiserLinkProposal resource. Format: properties/{propertyId}/displayVideo360AdvertiserLinkProposals/{proposalId} Note: proposalId is not the Display & Video 360 Advertiser ID + "name": "A String", # Identifier. The resource name for this DisplayVideo360AdvertiserLinkProposal resource. Format: properties/{propertyId}/displayVideo360AdvertiserLinkProposals/{proposalId} Note: proposalId is not the Display & Video 360 Advertiser ID "validationEmail": "A String", # Input only. On a proposal being sent to Display & Video 360, this field must be set to the email address of an admin on the target advertiser. This is used to verify that the Google Analytics admin is aware of at least one admin on the Display & Video 360 Advertiser. This does not restrict approval of the proposal to a single user. Any admin on the Display & Video 360 Advertiser may approve the proposal. }
@@ -297,7 +297,7 @@

Method Details

"linkProposalState": "A String", # Output only. The state of this proposal. "requestorEmail": "A String", # Output only. The email address of the user that proposed this linkage. }, - "name": "A String", # Output only. The resource name for this DisplayVideo360AdvertiserLinkProposal resource. Format: properties/{propertyId}/displayVideo360AdvertiserLinkProposals/{proposalId} Note: proposalId is not the Display & Video 360 Advertiser ID + "name": "A String", # Identifier. The resource name for this DisplayVideo360AdvertiserLinkProposal resource. Format: properties/{propertyId}/displayVideo360AdvertiserLinkProposals/{proposalId} Note: proposalId is not the Display & Video 360 Advertiser ID "validationEmail": "A String", # Input only. On a proposal being sent to Display & Video 360, this field must be set to the email address of an admin on the target advertiser. This is used to verify that the Google Analytics admin is aware of at least one admin on the Display & Video 360 Advertiser. This does not restrict approval of the proposal to a single user. Any admin on the Display & Video 360 Advertiser may approve the proposal. }, ], diff --git a/docs/dyn/analyticsadmin_v1alpha.properties.displayVideo360AdvertiserLinks.html b/docs/dyn/analyticsadmin_v1alpha.properties.displayVideo360AdvertiserLinks.html index 2326c437a0..8e4d8dcdc5 100644 --- a/docs/dyn/analyticsadmin_v1alpha.properties.displayVideo360AdvertiserLinks.html +++ b/docs/dyn/analyticsadmin_v1alpha.properties.displayVideo360AdvertiserLinks.html @@ -116,7 +116,7 @@

Method Details

"advertiserId": "A String", # Immutable. The Display & Video 360 Advertiser's advertiser ID. "campaignDataSharingEnabled": True or False, # Immutable. Enables the import of campaign data from Display & Video 360 into the Google Analytics property. After link creation, this can only be updated from the Display & Video 360 product. If this field is not set on create, it will be defaulted to true. "costDataSharingEnabled": True or False, # Immutable. Enables the import of cost data from Display & Video 360 into the Google Analytics property. This can only be enabled if `campaign_data_sharing_enabled` is true. After link creation, this can only be updated from the Display & Video 360 product. If this field is not set on create, it will be defaulted to true. - "name": "A String", # Output only. The resource name for this DisplayVideo360AdvertiserLink resource. Format: properties/{propertyId}/displayVideo360AdvertiserLinks/{linkId} Note: linkId is not the Display & Video 360 Advertiser ID + "name": "A String", # Identifier. The resource name for this DisplayVideo360AdvertiserLink resource. Format: properties/{propertyId}/displayVideo360AdvertiserLinks/{linkId} Note: linkId is not the Display & Video 360 Advertiser ID } x__xgafv: string, V1 error format. @@ -133,7 +133,7 @@

Method Details

"advertiserId": "A String", # Immutable. The Display & Video 360 Advertiser's advertiser ID. "campaignDataSharingEnabled": True or False, # Immutable. Enables the import of campaign data from Display & Video 360 into the Google Analytics property. After link creation, this can only be updated from the Display & Video 360 product. If this field is not set on create, it will be defaulted to true. "costDataSharingEnabled": True or False, # Immutable. Enables the import of cost data from Display & Video 360 into the Google Analytics property. This can only be enabled if `campaign_data_sharing_enabled` is true. After link creation, this can only be updated from the Display & Video 360 product. If this field is not set on create, it will be defaulted to true. - "name": "A String", # Output only. The resource name for this DisplayVideo360AdvertiserLink resource. Format: properties/{propertyId}/displayVideo360AdvertiserLinks/{linkId} Note: linkId is not the Display & Video 360 Advertiser ID + "name": "A String", # Identifier. The resource name for this DisplayVideo360AdvertiserLink resource. Format: properties/{propertyId}/displayVideo360AdvertiserLinks/{linkId} Note: linkId is not the Display & Video 360 Advertiser ID } @@ -175,7 +175,7 @@

Method Details

"advertiserId": "A String", # Immutable. The Display & Video 360 Advertiser's advertiser ID. "campaignDataSharingEnabled": True or False, # Immutable. Enables the import of campaign data from Display & Video 360 into the Google Analytics property. After link creation, this can only be updated from the Display & Video 360 product. If this field is not set on create, it will be defaulted to true. "costDataSharingEnabled": True or False, # Immutable. Enables the import of cost data from Display & Video 360 into the Google Analytics property. This can only be enabled if `campaign_data_sharing_enabled` is true. After link creation, this can only be updated from the Display & Video 360 product. If this field is not set on create, it will be defaulted to true. - "name": "A String", # Output only. The resource name for this DisplayVideo360AdvertiserLink resource. Format: properties/{propertyId}/displayVideo360AdvertiserLinks/{linkId} Note: linkId is not the Display & Video 360 Advertiser ID + "name": "A String", # Identifier. The resource name for this DisplayVideo360AdvertiserLink resource. Format: properties/{propertyId}/displayVideo360AdvertiserLinks/{linkId} Note: linkId is not the Display & Video 360 Advertiser ID } @@ -203,7 +203,7 @@

Method Details

"advertiserId": "A String", # Immutable. The Display & Video 360 Advertiser's advertiser ID. "campaignDataSharingEnabled": True or False, # Immutable. Enables the import of campaign data from Display & Video 360 into the Google Analytics property. After link creation, this can only be updated from the Display & Video 360 product. If this field is not set on create, it will be defaulted to true. "costDataSharingEnabled": True or False, # Immutable. Enables the import of cost data from Display & Video 360 into the Google Analytics property. This can only be enabled if `campaign_data_sharing_enabled` is true. After link creation, this can only be updated from the Display & Video 360 product. If this field is not set on create, it will be defaulted to true. - "name": "A String", # Output only. The resource name for this DisplayVideo360AdvertiserLink resource. Format: properties/{propertyId}/displayVideo360AdvertiserLinks/{linkId} Note: linkId is not the Display & Video 360 Advertiser ID + "name": "A String", # Identifier. The resource name for this DisplayVideo360AdvertiserLink resource. Format: properties/{propertyId}/displayVideo360AdvertiserLinks/{linkId} Note: linkId is not the Display & Video 360 Advertiser ID }, ], "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. @@ -229,7 +229,7 @@

Method Details

Updates a DisplayVideo360AdvertiserLink on a property.
 
 Args:
-  name: string, Output only. The resource name for this DisplayVideo360AdvertiserLink resource. Format: properties/{propertyId}/displayVideo360AdvertiserLinks/{linkId} Note: linkId is not the Display & Video 360 Advertiser ID (required)
+  name: string, Identifier. The resource name for this DisplayVideo360AdvertiserLink resource. Format: properties/{propertyId}/displayVideo360AdvertiserLinks/{linkId} Note: linkId is not the Display & Video 360 Advertiser ID (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -239,7 +239,7 @@ 

Method Details

"advertiserId": "A String", # Immutable. The Display & Video 360 Advertiser's advertiser ID. "campaignDataSharingEnabled": True or False, # Immutable. Enables the import of campaign data from Display & Video 360 into the Google Analytics property. After link creation, this can only be updated from the Display & Video 360 product. If this field is not set on create, it will be defaulted to true. "costDataSharingEnabled": True or False, # Immutable. Enables the import of cost data from Display & Video 360 into the Google Analytics property. This can only be enabled if `campaign_data_sharing_enabled` is true. After link creation, this can only be updated from the Display & Video 360 product. If this field is not set on create, it will be defaulted to true. - "name": "A String", # Output only. The resource name for this DisplayVideo360AdvertiserLink resource. Format: properties/{propertyId}/displayVideo360AdvertiserLinks/{linkId} Note: linkId is not the Display & Video 360 Advertiser ID + "name": "A String", # Identifier. The resource name for this DisplayVideo360AdvertiserLink resource. Format: properties/{propertyId}/displayVideo360AdvertiserLinks/{linkId} Note: linkId is not the Display & Video 360 Advertiser ID } updateMask: string, Required. The list of fields to be updated. Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields. @@ -257,7 +257,7 @@

Method Details

"advertiserId": "A String", # Immutable. The Display & Video 360 Advertiser's advertiser ID. "campaignDataSharingEnabled": True or False, # Immutable. Enables the import of campaign data from Display & Video 360 into the Google Analytics property. After link creation, this can only be updated from the Display & Video 360 product. If this field is not set on create, it will be defaulted to true. "costDataSharingEnabled": True or False, # Immutable. Enables the import of cost data from Display & Video 360 into the Google Analytics property. This can only be enabled if `campaign_data_sharing_enabled` is true. After link creation, this can only be updated from the Display & Video 360 product. If this field is not set on create, it will be defaulted to true. - "name": "A String", # Output only. The resource name for this DisplayVideo360AdvertiserLink resource. Format: properties/{propertyId}/displayVideo360AdvertiserLinks/{linkId} Note: linkId is not the Display & Video 360 Advertiser ID + "name": "A String", # Identifier. The resource name for this DisplayVideo360AdvertiserLink resource. Format: properties/{propertyId}/displayVideo360AdvertiserLinks/{linkId} Note: linkId is not the Display & Video 360 Advertiser ID }
diff --git a/docs/dyn/analyticsadmin_v1alpha.properties.firebaseLinks.html b/docs/dyn/analyticsadmin_v1alpha.properties.firebaseLinks.html index fe6b59b02a..813a87df73 100644 --- a/docs/dyn/analyticsadmin_v1alpha.properties.firebaseLinks.html +++ b/docs/dyn/analyticsadmin_v1alpha.properties.firebaseLinks.html @@ -106,7 +106,7 @@

Method Details

{ # A link between a Google Analytics property and a Firebase project. "createTime": "A String", # Output only. Time when this FirebaseLink was originally created. - "name": "A String", # Output only. Example format: properties/1234/firebaseLinks/5678 + "name": "A String", # Identifier. Example format: properties/1234/firebaseLinks/5678 "project": "A String", # Immutable. Firebase project resource name. When creating a FirebaseLink, you may provide this resource name using either a project number or project ID. Once this resource has been created, returned FirebaseLinks will always have a project_name that contains a project number. Format: 'projects/{project number}' Example: 'projects/1234' } @@ -120,7 +120,7 @@

Method Details

{ # A link between a Google Analytics property and a Firebase project. "createTime": "A String", # Output only. Time when this FirebaseLink was originally created. - "name": "A String", # Output only. Example format: properties/1234/firebaseLinks/5678 + "name": "A String", # Identifier. Example format: properties/1234/firebaseLinks/5678 "project": "A String", # Immutable. Firebase project resource name. When creating a FirebaseLink, you may provide this resource name using either a project number or project ID. Once this resource has been created, returned FirebaseLinks will always have a project_name that contains a project number. Format: 'projects/{project number}' Example: 'projects/1234' } @@ -149,8 +149,8 @@

Method Details

Args: parent: string, Required. Format: properties/{property_id} Example: `properties/1234` (required) - pageSize: integer, The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum) - pageToken: string, A page token, received from a previous `ListFirebaseLinks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListFirebaseLinks` must match the call that provided the page token. + pageSize: integer, Optional. The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum) + pageToken: string, Optional. A page token, received from a previous `ListFirebaseLinks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListFirebaseLinks` must match the call that provided the page token. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -163,7 +163,7 @@

Method Details

"firebaseLinks": [ # List of FirebaseLinks. This will have at most one value. { # A link between a Google Analytics property and a Firebase project. "createTime": "A String", # Output only. Time when this FirebaseLink was originally created. - "name": "A String", # Output only. Example format: properties/1234/firebaseLinks/5678 + "name": "A String", # Identifier. Example format: properties/1234/firebaseLinks/5678 "project": "A String", # Immutable. Firebase project resource name. When creating a FirebaseLink, you may provide this resource name using either a project number or project ID. Once this resource has been created, returned FirebaseLinks will always have a project_name that contains a project number. Format: 'projects/{project number}' Example: 'projects/1234' }, ], diff --git a/docs/dyn/analyticsadmin_v1alpha.properties.googleAdsLinks.html b/docs/dyn/analyticsadmin_v1alpha.properties.googleAdsLinks.html index f0b6e0c7b4..007948b6e8 100644 --- a/docs/dyn/analyticsadmin_v1alpha.properties.googleAdsLinks.html +++ b/docs/dyn/analyticsadmin_v1alpha.properties.googleAdsLinks.html @@ -113,7 +113,7 @@

Method Details

"createTime": "A String", # Output only. Time when this link was originally created. "creatorEmailAddress": "A String", # Output only. Email address of the user that created the link. An empty string will be returned if the email address can't be retrieved. "customerId": "A String", # Immutable. Google Ads customer ID. - "name": "A String", # Output only. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID. + "name": "A String", # Identifier. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID. "updateTime": "A String", # Output only. Time when this link was last updated. } @@ -131,7 +131,7 @@

Method Details

"createTime": "A String", # Output only. Time when this link was originally created. "creatorEmailAddress": "A String", # Output only. Email address of the user that created the link. An empty string will be returned if the email address can't be retrieved. "customerId": "A String", # Immutable. Google Ads customer ID. - "name": "A String", # Output only. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID. + "name": "A String", # Identifier. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID. "updateTime": "A String", # Output only. Time when this link was last updated. } @@ -160,8 +160,8 @@

Method Details

Args: parent: string, Required. Example format: properties/1234 (required) - pageSize: integer, The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum). - pageToken: string, A page token, received from a previous `ListGoogleAdsLinks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListGoogleAdsLinks` must match the call that provided the page token. + pageSize: integer, Optional. The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum). + pageToken: string, Optional. A page token, received from a previous `ListGoogleAdsLinks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListGoogleAdsLinks` must match the call that provided the page token. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -178,7 +178,7 @@

Method Details

"createTime": "A String", # Output only. Time when this link was originally created. "creatorEmailAddress": "A String", # Output only. Email address of the user that created the link. An empty string will be returned if the email address can't be retrieved. "customerId": "A String", # Immutable. Google Ads customer ID. - "name": "A String", # Output only. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID. + "name": "A String", # Identifier. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID. "updateTime": "A String", # Output only. Time when this link was last updated. }, ], @@ -205,7 +205,7 @@

Method Details

Updates a GoogleAdsLink on a property
 
 Args:
-  name: string, Output only. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID. (required)
+  name: string, Identifier. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -215,7 +215,7 @@ 

Method Details

"createTime": "A String", # Output only. Time when this link was originally created. "creatorEmailAddress": "A String", # Output only. Email address of the user that created the link. An empty string will be returned if the email address can't be retrieved. "customerId": "A String", # Immutable. Google Ads customer ID. - "name": "A String", # Output only. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID. + "name": "A String", # Identifier. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID. "updateTime": "A String", # Output only. Time when this link was last updated. } @@ -234,7 +234,7 @@

Method Details

"createTime": "A String", # Output only. Time when this link was originally created. "creatorEmailAddress": "A String", # Output only. Email address of the user that created the link. An empty string will be returned if the email address can't be retrieved. "customerId": "A String", # Immutable. Google Ads customer ID. - "name": "A String", # Output only. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID. + "name": "A String", # Identifier. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID. "updateTime": "A String", # Output only. Time when this link was last updated. }
diff --git a/docs/dyn/analyticsadmin_v1alpha.properties.html b/docs/dyn/analyticsadmin_v1alpha.properties.html index 79a06c564e..b7cdfc2b43 100644 --- a/docs/dyn/analyticsadmin_v1alpha.properties.html +++ b/docs/dyn/analyticsadmin_v1alpha.properties.html @@ -283,7 +283,7 @@

Method Details

"displayName": "A String", # Required. Human-readable display name for this property. The max allowed display name length is 100 UTF-16 code units. "expireTime": "A String", # Output only. If set, the time at which this trashed property will be permanently deleted. If not set, then this property is not currently in the trash can and is not slated to be deleted. "industryCategory": "A String", # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK - "name": "A String", # Output only. Resource name of this property. Format: properties/{property_id} Example: "properties/1000" + "name": "A String", # Identifier. Resource name of this property. Format: properties/{property_id} Example: "properties/1000" "parent": "A String", # Immutable. Resource name of this property's logical parent. Note: The Property-Moving UI can be used to change the parent. Format: accounts/{account}, properties/{property} Example: "accounts/100", "properties/101" "propertyType": "A String", # Immutable. The property type for this Property resource. When creating a property, if the type is "PROPERTY_TYPE_UNSPECIFIED", then "ORDINARY_PROPERTY" will be implied. "serviceLevel": "A String", # Output only. The Google Analytics service level that applies to this property. @@ -307,7 +307,7 @@

Method Details

"displayName": "A String", # Required. Human-readable display name for this property. The max allowed display name length is 100 UTF-16 code units. "expireTime": "A String", # Output only. If set, the time at which this trashed property will be permanently deleted. If not set, then this property is not currently in the trash can and is not slated to be deleted. "industryCategory": "A String", # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK - "name": "A String", # Output only. Resource name of this property. Format: properties/{property_id} Example: "properties/1000" + "name": "A String", # Identifier. Resource name of this property. Format: properties/{property_id} Example: "properties/1000" "parent": "A String", # Immutable. Resource name of this property's logical parent. Note: The Property-Moving UI can be used to change the parent. Format: accounts/{account}, properties/{property} Example: "accounts/100", "properties/101" "propertyType": "A String", # Immutable. The property type for this Property resource. When creating a property, if the type is "PROPERTY_TYPE_UNSPECIFIED", then "ORDINARY_PROPERTY" will be implied. "serviceLevel": "A String", # Output only. The Google Analytics service level that applies to this property. @@ -333,7 +333,7 @@

Method Details

"displayName": "A String", # Required. Human-readable display name for this property. The max allowed display name length is 100 UTF-16 code units. "expireTime": "A String", # Output only. If set, the time at which this trashed property will be permanently deleted. If not set, then this property is not currently in the trash can and is not slated to be deleted. "industryCategory": "A String", # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK - "name": "A String", # Output only. Resource name of this property. Format: properties/{property_id} Example: "properties/1000" + "name": "A String", # Identifier. Resource name of this property. Format: properties/{property_id} Example: "properties/1000" "parent": "A String", # Immutable. Resource name of this property's logical parent. Note: The Property-Moving UI can be used to change the parent. Format: accounts/{account}, properties/{property} Example: "accounts/100", "properties/101" "propertyType": "A String", # Immutable. The property type for this Property resource. When creating a property, if the type is "PROPERTY_TYPE_UNSPECIFIED", then "ORDINARY_PROPERTY" will be implied. "serviceLevel": "A String", # Output only. The Google Analytics service level that applies to this property. @@ -362,7 +362,7 @@

Method Details

"displayName": "A String", # Required. Human-readable display name for this property. The max allowed display name length is 100 UTF-16 code units. "expireTime": "A String", # Output only. If set, the time at which this trashed property will be permanently deleted. If not set, then this property is not currently in the trash can and is not slated to be deleted. "industryCategory": "A String", # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK - "name": "A String", # Output only. Resource name of this property. Format: properties/{property_id} Example: "properties/1000" + "name": "A String", # Identifier. Resource name of this property. Format: properties/{property_id} Example: "properties/1000" "parent": "A String", # Immutable. Resource name of this property's logical parent. Note: The Property-Moving UI can be used to change the parent. Format: accounts/{account}, properties/{property} Example: "accounts/100", "properties/101" "propertyType": "A String", # Immutable. The property type for this Property resource. When creating a property, if the type is "PROPERTY_TYPE_UNSPECIFIED", then "ORDINARY_PROPERTY" will be implied. "serviceLevel": "A String", # Output only. The Google Analytics service level that applies to this property. @@ -400,7 +400,7 @@

Method Details

"displayName": "A String", # Required. Human-readable display name for this property. The max allowed display name length is 100 UTF-16 code units. "expireTime": "A String", # Output only. If set, the time at which this trashed property will be permanently deleted. If not set, then this property is not currently in the trash can and is not slated to be deleted. "industryCategory": "A String", # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK - "name": "A String", # Output only. Resource name of this property. Format: properties/{property_id} Example: "properties/1000" + "name": "A String", # Identifier. Resource name of this property. Format: properties/{property_id} Example: "properties/1000" "parent": "A String", # Immutable. Resource name of this property's logical parent. Note: The Property-Moving UI can be used to change the parent. Format: accounts/{account}, properties/{property} Example: "accounts/100", "properties/101" "propertyType": "A String", # Immutable. The property type for this Property resource. When creating a property, if the type is "PROPERTY_TYPE_UNSPECIFIED", then "ORDINARY_PROPERTY" will be implied. "serviceLevel": "A String", # Output only. The Google Analytics service level that applies to this property. @@ -431,7 +431,7 @@

Method Details

"displayName": "A String", # Required. Human-readable display name for this property. The max allowed display name length is 100 UTF-16 code units. "expireTime": "A String", # Output only. If set, the time at which this trashed property will be permanently deleted. If not set, then this property is not currently in the trash can and is not slated to be deleted. "industryCategory": "A String", # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK - "name": "A String", # Output only. Resource name of this property. Format: properties/{property_id} Example: "properties/1000" + "name": "A String", # Identifier. Resource name of this property. Format: properties/{property_id} Example: "properties/1000" "parent": "A String", # Immutable. Resource name of this property's logical parent. Note: The Property-Moving UI can be used to change the parent. Format: accounts/{account}, properties/{property} Example: "accounts/100", "properties/101" "propertyType": "A String", # Immutable. The property type for this Property resource. When creating a property, if the type is "PROPERTY_TYPE_UNSPECIFIED", then "ORDINARY_PROPERTY" will be implied. "serviceLevel": "A String", # Output only. The Google Analytics service level that applies to this property. @@ -479,7 +479,7 @@

Method Details

{ # Settings values for data retention. This is a singleton resource. "eventDataRetention": "A String", # Required. The length of time that event-level data is retained. - "name": "A String", # Output only. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings + "name": "A String", # Identifier. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings "resetUserDataOnNewActivity": True or False, # If true, reset the retention period for the user identifier with every event from that user. "userDataRetention": "A String", # Required. The length of time that user-level data is retained. } @@ -532,8 +532,8 @@

Method Details

Args: filter: string, Required. An expression for filtering the results of the request. Fields eligible for filtering are: `parent:`(The resource name of the parent account/property) or `ancestor:`(The resource name of the parent account) or `firebase_project:`(The id or number of the linked firebase project). Some examples of filters: ``` | Filter | Description | |-----------------------------|-------------------------------------------| | parent:accounts/123 | The account with account id: 123. | | parent:properties/123 | The property with property id: 123. | | ancestor:accounts/123 | The account with account id: 123. | | firebase_project:project-id | The firebase project with id: project-id. | | firebase_project:123 | The firebase project with number: 123. | ``` - pageSize: integer, The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum) - pageToken: string, A page token, received from a previous `ListProperties` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListProperties` must match the call that provided the page token. + pageSize: integer, Optional. The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum) + pageToken: string, Optional. A page token, received from a previous `ListProperties` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListProperties` must match the call that provided the page token. showDeleted: boolean, Whether to include soft-deleted (ie: "trashed") Properties in the results. Properties can be inspected to determine whether they are deleted or not. x__xgafv: string, V1 error format. Allowed values @@ -554,7 +554,7 @@

Method Details

"displayName": "A String", # Required. Human-readable display name for this property. The max allowed display name length is 100 UTF-16 code units. "expireTime": "A String", # Output only. If set, the time at which this trashed property will be permanently deleted. If not set, then this property is not currently in the trash can and is not slated to be deleted. "industryCategory": "A String", # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK - "name": "A String", # Output only. Resource name of this property. Format: properties/{property_id} Example: "properties/1000" + "name": "A String", # Identifier. Resource name of this property. Format: properties/{property_id} Example: "properties/1000" "parent": "A String", # Immutable. Resource name of this property's logical parent. Note: The Property-Moving UI can be used to change the parent. Format: accounts/{account}, properties/{property} Example: "accounts/100", "properties/101" "propertyType": "A String", # Immutable. The property type for this Property resource. When creating a property, if the type is "PROPERTY_TYPE_UNSPECIFIED", then "ORDINARY_PROPERTY" will be implied. "serviceLevel": "A String", # Output only. The Google Analytics service level that applies to this property. @@ -584,7 +584,7 @@

Method Details

Updates a property.
 
 Args:
-  name: string, Output only. Resource name of this property. Format: properties/{property_id} Example: "properties/1000" (required)
+  name: string, Identifier. Resource name of this property. Format: properties/{property_id} Example: "properties/1000" (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -596,7 +596,7 @@ 

Method Details

"displayName": "A String", # Required. Human-readable display name for this property. The max allowed display name length is 100 UTF-16 code units. "expireTime": "A String", # Output only. If set, the time at which this trashed property will be permanently deleted. If not set, then this property is not currently in the trash can and is not slated to be deleted. "industryCategory": "A String", # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK - "name": "A String", # Output only. Resource name of this property. Format: properties/{property_id} Example: "properties/1000" + "name": "A String", # Identifier. Resource name of this property. Format: properties/{property_id} Example: "properties/1000" "parent": "A String", # Immutable. Resource name of this property's logical parent. Note: The Property-Moving UI can be used to change the parent. Format: accounts/{account}, properties/{property} Example: "accounts/100", "properties/101" "propertyType": "A String", # Immutable. The property type for this Property resource. When creating a property, if the type is "PROPERTY_TYPE_UNSPECIFIED", then "ORDINARY_PROPERTY" will be implied. "serviceLevel": "A String", # Output only. The Google Analytics service level that applies to this property. @@ -621,7 +621,7 @@

Method Details

"displayName": "A String", # Required. Human-readable display name for this property. The max allowed display name length is 100 UTF-16 code units. "expireTime": "A String", # Output only. If set, the time at which this trashed property will be permanently deleted. If not set, then this property is not currently in the trash can and is not slated to be deleted. "industryCategory": "A String", # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK - "name": "A String", # Output only. Resource name of this property. Format: properties/{property_id} Example: "properties/1000" + "name": "A String", # Identifier. Resource name of this property. Format: properties/{property_id} Example: "properties/1000" "parent": "A String", # Immutable. Resource name of this property's logical parent. Note: The Property-Moving UI can be used to change the parent. Format: accounts/{account}, properties/{property} Example: "accounts/100", "properties/101" "propertyType": "A String", # Immutable. The property type for this Property resource. When creating a property, if the type is "PROPERTY_TYPE_UNSPECIFIED", then "ORDINARY_PROPERTY" will be implied. "serviceLevel": "A String", # Output only. The Google Analytics service level that applies to this property. @@ -648,7 +648,7 @@

Method Details

"displayName": "A String", # Required. Human-readable display name for this property. The max allowed display name length is 100 UTF-16 code units. "expireTime": "A String", # Output only. If set, the time at which this trashed property will be permanently deleted. If not set, then this property is not currently in the trash can and is not slated to be deleted. "industryCategory": "A String", # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK - "name": "A String", # Output only. Resource name of this property. Format: properties/{property_id} Example: "properties/1000" + "name": "A String", # Identifier. Resource name of this property. Format: properties/{property_id} Example: "properties/1000" "parent": "A String", # Immutable. Resource name of this property's logical parent. Note: The Property-Moving UI can be used to change the parent. Format: accounts/{account}, properties/{property} Example: "accounts/100", "properties/101" "propertyType": "A String", # Immutable. The property type for this Property resource. When creating a property, if the type is "PROPERTY_TYPE_UNSPECIFIED", then "ORDINARY_PROPERTY" will be implied. "serviceLevel": "A String", # Output only. The Google Analytics service level that applies to this property. @@ -700,7 +700,7 @@

Method Details

"displayName": "A String", # Required. Human-readable display name for this property. The max allowed display name length is 100 UTF-16 code units. "expireTime": "A String", # Output only. If set, the time at which this trashed property will be permanently deleted. If not set, then this property is not currently in the trash can and is not slated to be deleted. "industryCategory": "A String", # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK - "name": "A String", # Output only. Resource name of this property. Format: properties/{property_id} Example: "properties/1000" + "name": "A String", # Identifier. Resource name of this property. Format: properties/{property_id} Example: "properties/1000" "parent": "A String", # Immutable. Resource name of this property's logical parent. Note: The Property-Moving UI can be used to change the parent. Format: accounts/{account}, properties/{property} Example: "accounts/100", "properties/101" "propertyType": "A String", # Immutable. The property type for this Property resource. When creating a property, if the type is "PROPERTY_TYPE_UNSPECIFIED", then "ORDINARY_PROPERTY" will be implied. "serviceLevel": "A String", # Output only. The Google Analytics service level that applies to this property. @@ -998,13 +998,13 @@

Method Details

Updates the singleton data retention settings for this property.
 
 Args:
-  name: string, Output only. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings (required)
+  name: string, Identifier. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings (required)
   body: object, The request body.
     The object takes the form of:
 
 { # Settings values for data retention. This is a singleton resource.
   "eventDataRetention": "A String", # Required. The length of time that event-level data is retained.
-  "name": "A String", # Output only. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings
+  "name": "A String", # Identifier. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings
   "resetUserDataOnNewActivity": True or False, # If true, reset the retention period for the user identifier with every event from that user.
   "userDataRetention": "A String", # Required. The length of time that user-level data is retained.
 }
@@ -1020,7 +1020,7 @@ 

Method Details

{ # Settings values for data retention. This is a singleton resource. "eventDataRetention": "A String", # Required. The length of time that event-level data is retained. - "name": "A String", # Output only. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings + "name": "A String", # Identifier. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings "resetUserDataOnNewActivity": True or False, # If true, reset the retention period for the user identifier with every event from that user. "userDataRetention": "A String", # Required. The length of time that user-level data is retained. }
diff --git a/docs/dyn/analyticsadmin_v1alpha.properties.keyEvents.html b/docs/dyn/analyticsadmin_v1alpha.properties.keyEvents.html index 8fd370a4f4..1c21e7f221 100644 --- a/docs/dyn/analyticsadmin_v1alpha.properties.keyEvents.html +++ b/docs/dyn/analyticsadmin_v1alpha.properties.keyEvents.html @@ -197,8 +197,8 @@

Method Details

Args: parent: string, Required. The resource name of the parent property. Example: 'properties/123' (required) - pageSize: integer, The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum) - pageToken: string, A page token, received from a previous `ListKeyEvents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListKeyEvents` must match the call that provided the page token. + pageSize: integer, Optional. The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum) + pageToken: string, Optional. A page token, received from a previous `ListKeyEvents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListKeyEvents` must match the call that provided the page token. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/analyticsadmin_v1alpha.properties.searchAds360Links.html b/docs/dyn/analyticsadmin_v1alpha.properties.searchAds360Links.html index 40b76b3c75..bc8ae9bf5a 100644 --- a/docs/dyn/analyticsadmin_v1alpha.properties.searchAds360Links.html +++ b/docs/dyn/analyticsadmin_v1alpha.properties.searchAds360Links.html @@ -116,7 +116,7 @@

Method Details

"advertiserId": "A String", # Immutable. This field represents the Advertiser ID of the Search Ads 360 Advertiser. that has been linked. "campaignDataSharingEnabled": True or False, # Immutable. Enables the import of campaign data from Search Ads 360 into the Google Analytics property. After link creation, this can only be updated from the Search Ads 360 product. If this field is not set on create, it will be defaulted to true. "costDataSharingEnabled": True or False, # Immutable. Enables the import of cost data from Search Ads 360 to the Google Analytics property. This can only be enabled if campaign_data_sharing_enabled is enabled. After link creation, this can only be updated from the Search Ads 360 product. If this field is not set on create, it will be defaulted to true. - "name": "A String", # Output only. The resource name for this SearchAds360Link resource. Format: properties/{propertyId}/searchAds360Links/{linkId} Note: linkId is not the Search Ads 360 advertiser ID + "name": "A String", # Identifier. The resource name for this SearchAds360Link resource. Format: properties/{propertyId}/searchAds360Links/{linkId} Note: linkId is not the Search Ads 360 advertiser ID "siteStatsSharingEnabled": True or False, # Enables export of site stats with this integration. If this field is not set on create, it will be defaulted to true. } @@ -134,7 +134,7 @@

Method Details

"advertiserId": "A String", # Immutable. This field represents the Advertiser ID of the Search Ads 360 Advertiser. that has been linked. "campaignDataSharingEnabled": True or False, # Immutable. Enables the import of campaign data from Search Ads 360 into the Google Analytics property. After link creation, this can only be updated from the Search Ads 360 product. If this field is not set on create, it will be defaulted to true. "costDataSharingEnabled": True or False, # Immutable. Enables the import of cost data from Search Ads 360 to the Google Analytics property. This can only be enabled if campaign_data_sharing_enabled is enabled. After link creation, this can only be updated from the Search Ads 360 product. If this field is not set on create, it will be defaulted to true. - "name": "A String", # Output only. The resource name for this SearchAds360Link resource. Format: properties/{propertyId}/searchAds360Links/{linkId} Note: linkId is not the Search Ads 360 advertiser ID + "name": "A String", # Identifier. The resource name for this SearchAds360Link resource. Format: properties/{propertyId}/searchAds360Links/{linkId} Note: linkId is not the Search Ads 360 advertiser ID "siteStatsSharingEnabled": True or False, # Enables export of site stats with this integration. If this field is not set on create, it will be defaulted to true. }
@@ -177,7 +177,7 @@

Method Details

"advertiserId": "A String", # Immutable. This field represents the Advertiser ID of the Search Ads 360 Advertiser. that has been linked. "campaignDataSharingEnabled": True or False, # Immutable. Enables the import of campaign data from Search Ads 360 into the Google Analytics property. After link creation, this can only be updated from the Search Ads 360 product. If this field is not set on create, it will be defaulted to true. "costDataSharingEnabled": True or False, # Immutable. Enables the import of cost data from Search Ads 360 to the Google Analytics property. This can only be enabled if campaign_data_sharing_enabled is enabled. After link creation, this can only be updated from the Search Ads 360 product. If this field is not set on create, it will be defaulted to true. - "name": "A String", # Output only. The resource name for this SearchAds360Link resource. Format: properties/{propertyId}/searchAds360Links/{linkId} Note: linkId is not the Search Ads 360 advertiser ID + "name": "A String", # Identifier. The resource name for this SearchAds360Link resource. Format: properties/{propertyId}/searchAds360Links/{linkId} Note: linkId is not the Search Ads 360 advertiser ID "siteStatsSharingEnabled": True or False, # Enables export of site stats with this integration. If this field is not set on create, it will be defaulted to true. } @@ -207,7 +207,7 @@

Method Details

"advertiserId": "A String", # Immutable. This field represents the Advertiser ID of the Search Ads 360 Advertiser. that has been linked. "campaignDataSharingEnabled": True or False, # Immutable. Enables the import of campaign data from Search Ads 360 into the Google Analytics property. After link creation, this can only be updated from the Search Ads 360 product. If this field is not set on create, it will be defaulted to true. "costDataSharingEnabled": True or False, # Immutable. Enables the import of cost data from Search Ads 360 to the Google Analytics property. This can only be enabled if campaign_data_sharing_enabled is enabled. After link creation, this can only be updated from the Search Ads 360 product. If this field is not set on create, it will be defaulted to true. - "name": "A String", # Output only. The resource name for this SearchAds360Link resource. Format: properties/{propertyId}/searchAds360Links/{linkId} Note: linkId is not the Search Ads 360 advertiser ID + "name": "A String", # Identifier. The resource name for this SearchAds360Link resource. Format: properties/{propertyId}/searchAds360Links/{linkId} Note: linkId is not the Search Ads 360 advertiser ID "siteStatsSharingEnabled": True or False, # Enables export of site stats with this integration. If this field is not set on create, it will be defaulted to true. }, ], @@ -233,7 +233,7 @@

Method Details

Updates a SearchAds360Link on a property.
 
 Args:
-  name: string, Output only. The resource name for this SearchAds360Link resource. Format: properties/{propertyId}/searchAds360Links/{linkId} Note: linkId is not the Search Ads 360 advertiser ID (required)
+  name: string, Identifier. The resource name for this SearchAds360Link resource. Format: properties/{propertyId}/searchAds360Links/{linkId} Note: linkId is not the Search Ads 360 advertiser ID (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -243,7 +243,7 @@ 

Method Details

"advertiserId": "A String", # Immutable. This field represents the Advertiser ID of the Search Ads 360 Advertiser. that has been linked. "campaignDataSharingEnabled": True or False, # Immutable. Enables the import of campaign data from Search Ads 360 into the Google Analytics property. After link creation, this can only be updated from the Search Ads 360 product. If this field is not set on create, it will be defaulted to true. "costDataSharingEnabled": True or False, # Immutable. Enables the import of cost data from Search Ads 360 to the Google Analytics property. This can only be enabled if campaign_data_sharing_enabled is enabled. After link creation, this can only be updated from the Search Ads 360 product. If this field is not set on create, it will be defaulted to true. - "name": "A String", # Output only. The resource name for this SearchAds360Link resource. Format: properties/{propertyId}/searchAds360Links/{linkId} Note: linkId is not the Search Ads 360 advertiser ID + "name": "A String", # Identifier. The resource name for this SearchAds360Link resource. Format: properties/{propertyId}/searchAds360Links/{linkId} Note: linkId is not the Search Ads 360 advertiser ID "siteStatsSharingEnabled": True or False, # Enables export of site stats with this integration. If this field is not set on create, it will be defaulted to true. } @@ -262,7 +262,7 @@

Method Details

"advertiserId": "A String", # Immutable. This field represents the Advertiser ID of the Search Ads 360 Advertiser. that has been linked. "campaignDataSharingEnabled": True or False, # Immutable. Enables the import of campaign data from Search Ads 360 into the Google Analytics property. After link creation, this can only be updated from the Search Ads 360 product. If this field is not set on create, it will be defaulted to true. "costDataSharingEnabled": True or False, # Immutable. Enables the import of cost data from Search Ads 360 to the Google Analytics property. This can only be enabled if campaign_data_sharing_enabled is enabled. After link creation, this can only be updated from the Search Ads 360 product. If this field is not set on create, it will be defaulted to true. - "name": "A String", # Output only. The resource name for this SearchAds360Link resource. Format: properties/{propertyId}/searchAds360Links/{linkId} Note: linkId is not the Search Ads 360 advertiser ID + "name": "A String", # Identifier. The resource name for this SearchAds360Link resource. Format: properties/{propertyId}/searchAds360Links/{linkId} Note: linkId is not the Search Ads 360 advertiser ID "siteStatsSharingEnabled": True or False, # Enables export of site stats with this integration. If this field is not set on create, it will be defaulted to true. }
diff --git a/docs/dyn/analyticsadmin_v1beta.accountSummaries.html b/docs/dyn/analyticsadmin_v1beta.accountSummaries.html index 3d2ff3d893..eb2896a112 100644 --- a/docs/dyn/analyticsadmin_v1beta.accountSummaries.html +++ b/docs/dyn/analyticsadmin_v1beta.accountSummaries.html @@ -94,8 +94,8 @@

Method Details

Returns summaries of all accounts accessible by the caller.
 
 Args:
-  pageSize: integer, The maximum number of AccountSummary resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)
-  pageToken: string, A page token, received from a previous `ListAccountSummaries` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccountSummaries` must match the call that provided the page token.
+  pageSize: integer, Optional. The maximum number of AccountSummary resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)
+  pageToken: string, Optional. A page token, received from a previous `ListAccountSummaries` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccountSummaries` must match the call that provided the page token.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -109,7 +109,7 @@ 

Method Details

{ # A virtual resource representing an overview of an account and all its child Google Analytics properties. "account": "A String", # Resource name of account referred to by this account summary Format: accounts/{account_id} Example: "accounts/1000" "displayName": "A String", # Display name for the account referred to in this account summary. - "name": "A String", # Resource name for this account summary. Format: accountSummaries/{account_id} Example: "accountSummaries/1000" + "name": "A String", # Identifier. Resource name for this account summary. Format: accountSummaries/{account_id} Example: "accountSummaries/1000" "propertySummaries": [ # List of summaries for child accounts of this account. { # A virtual resource representing metadata for a Google Analytics property. "displayName": "A String", # Display name for the property referred to in this property summary. diff --git a/docs/dyn/analyticsadmin_v1beta.accounts.html b/docs/dyn/analyticsadmin_v1beta.accounts.html index c186f27cbb..0a759b7474 100644 --- a/docs/dyn/analyticsadmin_v1beta.accounts.html +++ b/docs/dyn/analyticsadmin_v1beta.accounts.html @@ -150,7 +150,7 @@

Method Details

"deleted": True or False, # Output only. Indicates whether this Account is soft-deleted or not. Deleted accounts are excluded from List results unless specifically requested. "displayName": "A String", # Required. Human-readable display name for this account. "gmpOrganization": "A String", # Output only. The URI for a Google Marketing Platform organization resource. Only set when this account is connected to a GMP organization. Format: marketingplatformadmin.googleapis.com/organizations/{org_id} - "name": "A String", # Output only. Resource name of this account. Format: accounts/{account} Example: "accounts/100" + "name": "A String", # Identifier. Resource name of this account. Format: accounts/{account} Example: "accounts/100" "regionCode": "A String", # Country of business. Must be a Unicode CLDR region code. "updateTime": "A String", # Output only. Time when account payload fields were last updated. }
@@ -171,7 +171,7 @@

Method Details

An object of the form: { # A resource message representing data sharing settings of a Google Analytics account. - "name": "A String", # Output only. Resource name. Format: accounts/{account}/dataSharingSettings Example: "accounts/1000/dataSharingSettings" + "name": "A String", # Identifier. Resource name. Format: accounts/{account}/dataSharingSettings Example: "accounts/1000/dataSharingSettings" "sharingWithGoogleAnySalesEnabled": True or False, # Deprecated. This field is no longer used and always returns false. "sharingWithGoogleAssignedSalesEnabled": True or False, # Allows Google access to your Google Analytics account data, including account usage and configuration data, product spending, and users associated with your Google Analytics account, so that Google can help you make the most of Google products, providing you with insights, offers, recommendations, and optimization tips across Google Analytics and other Google products for business. This field maps to the "Recommendations for your business" field in the Google Analytics Admin UI. "sharingWithGoogleProductsEnabled": True or False, # Allows Google to use the data to improve other Google products or services. This fields maps to the "Google products & services" field in the Google Analytics Admin UI. @@ -185,8 +185,8 @@

Method Details

Returns all accounts accessible by the caller. Note that these accounts might not currently have GA properties. Soft-deleted (ie: "trashed") accounts are excluded by default. Returns an empty list if no relevant accounts are found.
 
 Args:
-  pageSize: integer, The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)
-  pageToken: string, A page token, received from a previous `ListAccounts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccounts` must match the call that provided the page token.
+  pageSize: integer, Optional. The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)
+  pageToken: string, Optional. A page token, received from a previous `ListAccounts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccounts` must match the call that provided the page token.
   showDeleted: boolean, Whether to include soft-deleted (ie: "trashed") Accounts in the results. Accounts can be inspected to determine whether they are deleted or not.
   x__xgafv: string, V1 error format.
     Allowed values
@@ -203,7 +203,7 @@ 

Method Details

"deleted": True or False, # Output only. Indicates whether this Account is soft-deleted or not. Deleted accounts are excluded from List results unless specifically requested. "displayName": "A String", # Required. Human-readable display name for this account. "gmpOrganization": "A String", # Output only. The URI for a Google Marketing Platform organization resource. Only set when this account is connected to a GMP organization. Format: marketingplatformadmin.googleapis.com/organizations/{org_id} - "name": "A String", # Output only. Resource name of this account. Format: accounts/{account} Example: "accounts/100" + "name": "A String", # Identifier. Resource name of this account. Format: accounts/{account} Example: "accounts/100" "regionCode": "A String", # Country of business. Must be a Unicode CLDR region code. "updateTime": "A String", # Output only. Time when account payload fields were last updated. }, @@ -231,7 +231,7 @@

Method Details

Updates an account.
 
 Args:
-  name: string, Output only. Resource name of this account. Format: accounts/{account} Example: "accounts/100" (required)
+  name: string, Identifier. Resource name of this account. Format: accounts/{account} Example: "accounts/100" (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -240,7 +240,7 @@ 

Method Details

"deleted": True or False, # Output only. Indicates whether this Account is soft-deleted or not. Deleted accounts are excluded from List results unless specifically requested. "displayName": "A String", # Required. Human-readable display name for this account. "gmpOrganization": "A String", # Output only. The URI for a Google Marketing Platform organization resource. Only set when this account is connected to a GMP organization. Format: marketingplatformadmin.googleapis.com/organizations/{org_id} - "name": "A String", # Output only. Resource name of this account. Format: accounts/{account} Example: "accounts/100" + "name": "A String", # Identifier. Resource name of this account. Format: accounts/{account} Example: "accounts/100" "regionCode": "A String", # Country of business. Must be a Unicode CLDR region code. "updateTime": "A String", # Output only. Time when account payload fields were last updated. } @@ -259,7 +259,7 @@

Method Details

"deleted": True or False, # Output only. Indicates whether this Account is soft-deleted or not. Deleted accounts are excluded from List results unless specifically requested. "displayName": "A String", # Required. Human-readable display name for this account. "gmpOrganization": "A String", # Output only. The URI for a Google Marketing Platform organization resource. Only set when this account is connected to a GMP organization. Format: marketingplatformadmin.googleapis.com/organizations/{org_id} - "name": "A String", # Output only. Resource name of this account. Format: accounts/{account} Example: "accounts/100" + "name": "A String", # Identifier. Resource name of this account. Format: accounts/{account} Example: "accounts/100" "regionCode": "A String", # Country of business. Must be a Unicode CLDR region code. "updateTime": "A String", # Output only. Time when account payload fields were last updated. }
@@ -279,7 +279,7 @@

Method Details

"deleted": True or False, # Output only. Indicates whether this Account is soft-deleted or not. Deleted accounts are excluded from List results unless specifically requested. "displayName": "A String", # Required. Human-readable display name for this account. "gmpOrganization": "A String", # Output only. The URI for a Google Marketing Platform organization resource. Only set when this account is connected to a GMP organization. Format: marketingplatformadmin.googleapis.com/organizations/{org_id} - "name": "A String", # Output only. Resource name of this account. Format: accounts/{account} Example: "accounts/100" + "name": "A String", # Identifier. Resource name of this account. Format: accounts/{account} Example: "accounts/100" "regionCode": "A String", # Country of business. Must be a Unicode CLDR region code. "updateTime": "A String", # Output only. Time when account payload fields were last updated. }, @@ -541,7 +541,7 @@

Method Details

"deleted": True or False, # Output only. Indicates whether this Account is soft-deleted or not. Deleted accounts are excluded from List results unless specifically requested. "displayName": "A String", # Required. Human-readable display name for this account. "gmpOrganization": "A String", # Output only. The URI for a Google Marketing Platform organization resource. Only set when this account is connected to a GMP organization. Format: marketingplatformadmin.googleapis.com/organizations/{org_id} - "name": "A String", # Output only. Resource name of this account. Format: accounts/{account} Example: "accounts/100" + "name": "A String", # Identifier. Resource name of this account. Format: accounts/{account} Example: "accounts/100" "regionCode": "A String", # Country of business. Must be a Unicode CLDR region code. "updateTime": "A String", # Output only. Time when account payload fields were last updated. }, @@ -555,11 +555,11 @@

Method Details

}, "deletable": True or False, # Output only. If set, this event can currently be deleted with DeleteConversionEvent. "eventName": "A String", # Immutable. The event name for this conversion event. Examples: 'click', 'purchase' - "name": "A String", # Output only. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event} + "name": "A String", # Identifier. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event} }, "dataRetentionSettings": { # Settings values for data retention. This is a singleton resource. # A snapshot of a data retention settings resource in change history. "eventDataRetention": "A String", # Required. The length of time that event-level data is retained. - "name": "A String", # Output only. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings + "name": "A String", # Identifier. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings "resetUserDataOnNewActivity": True or False, # If true, reset the retention period for the user identifier with every event from that user. "userDataRetention": "A String", # Required. The length of time that user-level data is retained. }, @@ -574,7 +574,7 @@

Method Details

"bundleId": "A String", # Required. Immutable. The Apple App Store Bundle ID for the app Example: "com.example.myiosapp" "firebaseAppId": "A String", # Output only. ID of the corresponding iOS app in Firebase, if any. This ID can change if the iOS app is deleted and recreated. }, - "name": "A String", # Output only. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: "properties/1000/dataStreams/2000" + "name": "A String", # Identifier. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: "properties/1000/dataStreams/2000" "type": "A String", # Required. Immutable. The type of this DataStream resource. "updateTime": "A String", # Output only. Time when stream payload fields were last updated. "webStreamData": { # Data specific to web streams. # Data specific to web streams. Must be populated if type is WEB_DATA_STREAM. @@ -585,7 +585,7 @@

Method Details

}, "firebaseLink": { # A link between a Google Analytics property and a Firebase project. # A snapshot of a FirebaseLink resource in change history. "createTime": "A String", # Output only. Time when this FirebaseLink was originally created. - "name": "A String", # Output only. Example format: properties/1234/firebaseLinks/5678 + "name": "A String", # Identifier. Example format: properties/1234/firebaseLinks/5678 "project": "A String", # Immutable. Firebase project resource name. When creating a FirebaseLink, you may provide this resource name using either a project number or project ID. Once this resource has been created, returned FirebaseLinks will always have a project_name that contains a project number. Format: 'projects/{project number}' Example: 'projects/1234' }, "googleAdsLink": { # A link between a Google Analytics property and a Google Ads account. # A snapshot of a GoogleAdsLink resource in change history. @@ -594,12 +594,12 @@

Method Details

"createTime": "A String", # Output only. Time when this link was originally created. "creatorEmailAddress": "A String", # Output only. Email address of the user that created the link. An empty string will be returned if the email address can't be retrieved. "customerId": "A String", # Immutable. Google Ads customer ID. - "name": "A String", # Output only. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID. + "name": "A String", # Identifier. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID. "updateTime": "A String", # Output only. Time when this link was last updated. }, "measurementProtocolSecret": { # A secret value used for sending hits to Measurement Protocol. # A snapshot of a MeasurementProtocolSecret resource in change history. "displayName": "A String", # Required. Human-readable display name for this secret. - "name": "A String", # Output only. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret} + "name": "A String", # Identifier. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret} "secretValue": "A String", # Output only. The measurement protocol secret value. Pass this value to the api_secret field of the Measurement Protocol API when sending hits to this secret's parent property. }, "property": { # A resource message representing a Google Analytics property. # A snapshot of a Property resource in change history. @@ -610,7 +610,7 @@

Method Details

"displayName": "A String", # Required. Human-readable display name for this property. The max allowed display name length is 100 UTF-16 code units. "expireTime": "A String", # Output only. If set, the time at which this trashed property will be permanently deleted. If not set, then this property is not currently in the trash can and is not slated to be deleted. "industryCategory": "A String", # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK - "name": "A String", # Output only. Resource name of this property. Format: properties/{property_id} Example: "properties/1000" + "name": "A String", # Identifier. Resource name of this property. Format: properties/{property_id} Example: "properties/1000" "parent": "A String", # Immutable. Resource name of this property's logical parent. Note: The Property-Moving UI can be used to change the parent. Format: accounts/{account}, properties/{property} Example: "accounts/100", "properties/101" "propertyType": "A String", # Immutable. The property type for this Property resource. When creating a property, if the type is "PROPERTY_TYPE_UNSPECIFIED", then "ORDINARY_PROPERTY" will be implied. "serviceLevel": "A String", # Output only. The Google Analytics service level that applies to this property. @@ -624,7 +624,7 @@

Method Details

"deleted": True or False, # Output only. Indicates whether this Account is soft-deleted or not. Deleted accounts are excluded from List results unless specifically requested. "displayName": "A String", # Required. Human-readable display name for this account. "gmpOrganization": "A String", # Output only. The URI for a Google Marketing Platform organization resource. Only set when this account is connected to a GMP organization. Format: marketingplatformadmin.googleapis.com/organizations/{org_id} - "name": "A String", # Output only. Resource name of this account. Format: accounts/{account} Example: "accounts/100" + "name": "A String", # Identifier. Resource name of this account. Format: accounts/{account} Example: "accounts/100" "regionCode": "A String", # Country of business. Must be a Unicode CLDR region code. "updateTime": "A String", # Output only. Time when account payload fields were last updated. }, @@ -638,11 +638,11 @@

Method Details

}, "deletable": True or False, # Output only. If set, this event can currently be deleted with DeleteConversionEvent. "eventName": "A String", # Immutable. The event name for this conversion event. Examples: 'click', 'purchase' - "name": "A String", # Output only. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event} + "name": "A String", # Identifier. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event} }, "dataRetentionSettings": { # Settings values for data retention. This is a singleton resource. # A snapshot of a data retention settings resource in change history. "eventDataRetention": "A String", # Required. The length of time that event-level data is retained. - "name": "A String", # Output only. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings + "name": "A String", # Identifier. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings "resetUserDataOnNewActivity": True or False, # If true, reset the retention period for the user identifier with every event from that user. "userDataRetention": "A String", # Required. The length of time that user-level data is retained. }, @@ -657,7 +657,7 @@

Method Details

"bundleId": "A String", # Required. Immutable. The Apple App Store Bundle ID for the app Example: "com.example.myiosapp" "firebaseAppId": "A String", # Output only. ID of the corresponding iOS app in Firebase, if any. This ID can change if the iOS app is deleted and recreated. }, - "name": "A String", # Output only. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: "properties/1000/dataStreams/2000" + "name": "A String", # Identifier. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: "properties/1000/dataStreams/2000" "type": "A String", # Required. Immutable. The type of this DataStream resource. "updateTime": "A String", # Output only. Time when stream payload fields were last updated. "webStreamData": { # Data specific to web streams. # Data specific to web streams. Must be populated if type is WEB_DATA_STREAM. @@ -668,7 +668,7 @@

Method Details

}, "firebaseLink": { # A link between a Google Analytics property and a Firebase project. # A snapshot of a FirebaseLink resource in change history. "createTime": "A String", # Output only. Time when this FirebaseLink was originally created. - "name": "A String", # Output only. Example format: properties/1234/firebaseLinks/5678 + "name": "A String", # Identifier. Example format: properties/1234/firebaseLinks/5678 "project": "A String", # Immutable. Firebase project resource name. When creating a FirebaseLink, you may provide this resource name using either a project number or project ID. Once this resource has been created, returned FirebaseLinks will always have a project_name that contains a project number. Format: 'projects/{project number}' Example: 'projects/1234' }, "googleAdsLink": { # A link between a Google Analytics property and a Google Ads account. # A snapshot of a GoogleAdsLink resource in change history. @@ -677,12 +677,12 @@

Method Details

"createTime": "A String", # Output only. Time when this link was originally created. "creatorEmailAddress": "A String", # Output only. Email address of the user that created the link. An empty string will be returned if the email address can't be retrieved. "customerId": "A String", # Immutable. Google Ads customer ID. - "name": "A String", # Output only. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID. + "name": "A String", # Identifier. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID. "updateTime": "A String", # Output only. Time when this link was last updated. }, "measurementProtocolSecret": { # A secret value used for sending hits to Measurement Protocol. # A snapshot of a MeasurementProtocolSecret resource in change history. "displayName": "A String", # Required. Human-readable display name for this secret. - "name": "A String", # Output only. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret} + "name": "A String", # Identifier. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret} "secretValue": "A String", # Output only. The measurement protocol secret value. Pass this value to the api_secret field of the Measurement Protocol API when sending hits to this secret's parent property. }, "property": { # A resource message representing a Google Analytics property. # A snapshot of a Property resource in change history. @@ -693,7 +693,7 @@

Method Details

"displayName": "A String", # Required. Human-readable display name for this property. The max allowed display name length is 100 UTF-16 code units. "expireTime": "A String", # Output only. If set, the time at which this trashed property will be permanently deleted. If not set, then this property is not currently in the trash can and is not slated to be deleted. "industryCategory": "A String", # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK - "name": "A String", # Output only. Resource name of this property. Format: properties/{property_id} Example: "properties/1000" + "name": "A String", # Identifier. Resource name of this property. Format: properties/{property_id} Example: "properties/1000" "parent": "A String", # Immutable. Resource name of this property's logical parent. Note: The Property-Moving UI can be used to change the parent. Format: accounts/{account}, properties/{property} Example: "accounts/100", "properties/101" "propertyType": "A String", # Immutable. The property type for this Property resource. When creating a property, if the type is "PROPERTY_TYPE_UNSPECIFIED", then "ORDINARY_PROPERTY" will be implied. "serviceLevel": "A String", # Output only. The Google Analytics service level that applies to this property. diff --git a/docs/dyn/analyticsadmin_v1beta.properties.conversionEvents.html b/docs/dyn/analyticsadmin_v1beta.properties.conversionEvents.html index 042317e3ef..e6502441a8 100644 --- a/docs/dyn/analyticsadmin_v1beta.properties.conversionEvents.html +++ b/docs/dyn/analyticsadmin_v1beta.properties.conversionEvents.html @@ -120,7 +120,7 @@

Method Details

}, "deletable": True or False, # Output only. If set, this event can currently be deleted with DeleteConversionEvent. "eventName": "A String", # Immutable. The event name for this conversion event. Examples: 'click', 'purchase' - "name": "A String", # Output only. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event} + "name": "A String", # Identifier. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event} } x__xgafv: string, V1 error format. @@ -141,7 +141,7 @@

Method Details

}, "deletable": True or False, # Output only. If set, this event can currently be deleted with DeleteConversionEvent. "eventName": "A String", # Immutable. The event name for this conversion event. Examples: 'click', 'purchase' - "name": "A String", # Output only. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event} + "name": "A String", # Identifier. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event} }
@@ -187,7 +187,7 @@

Method Details

}, "deletable": True or False, # Output only. If set, this event can currently be deleted with DeleteConversionEvent. "eventName": "A String", # Immutable. The event name for this conversion event. Examples: 'click', 'purchase' - "name": "A String", # Output only. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event} + "name": "A String", # Identifier. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event} } @@ -197,8 +197,8 @@

Method Details

Args: parent: string, Required. The resource name of the parent property. Example: 'properties/123' (required) - pageSize: integer, The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum) - pageToken: string, A page token, received from a previous `ListConversionEvents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListConversionEvents` must match the call that provided the page token. + pageSize: integer, Optional. The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum) + pageToken: string, Optional. A page token, received from a previous `ListConversionEvents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListConversionEvents` must match the call that provided the page token. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -219,7 +219,7 @@

Method Details

}, "deletable": True or False, # Output only. If set, this event can currently be deleted with DeleteConversionEvent. "eventName": "A String", # Immutable. The event name for this conversion event. Examples: 'click', 'purchase' - "name": "A String", # Output only. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event} + "name": "A String", # Identifier. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event} }, ], "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. @@ -245,7 +245,7 @@

Method Details

Deprecated: Use `UpdateKeyEvent` instead. Updates a conversion event with the specified attributes.
 
 Args:
-  name: string, Output only. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event} (required)
+  name: string, Identifier. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event} (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -259,7 +259,7 @@ 

Method Details

}, "deletable": True or False, # Output only. If set, this event can currently be deleted with DeleteConversionEvent. "eventName": "A String", # Immutable. The event name for this conversion event. Examples: 'click', 'purchase' - "name": "A String", # Output only. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event} + "name": "A String", # Identifier. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event} } updateMask: string, Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields. @@ -281,7 +281,7 @@

Method Details

}, "deletable": True or False, # Output only. If set, this event can currently be deleted with DeleteConversionEvent. "eventName": "A String", # Immutable. The event name for this conversion event. Examples: 'click', 'purchase' - "name": "A String", # Output only. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event} + "name": "A String", # Identifier. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event} }
diff --git a/docs/dyn/analyticsadmin_v1beta.properties.customDimensions.html b/docs/dyn/analyticsadmin_v1beta.properties.customDimensions.html index cf8d2ff9d8..5e4ff0e9b4 100644 --- a/docs/dyn/analyticsadmin_v1beta.properties.customDimensions.html +++ b/docs/dyn/analyticsadmin_v1beta.properties.customDimensions.html @@ -138,7 +138,7 @@

Method Details

"description": "A String", # Optional. Description for this custom dimension. Max length of 150 characters. "disallowAdsPersonalization": True or False, # Optional. If set to true, sets this dimension as NPA and excludes it from ads personalization. This is currently only supported by user-scoped custom dimensions. "displayName": "A String", # Required. Display name for this custom dimension as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets. - "name": "A String", # Output only. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension} + "name": "A String", # Identifier. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension} "parameterName": "A String", # Required. Immutable. Tagging parameter name for this custom dimension. If this is a user-scoped dimension, then this is the user property name. If this is an event-scoped dimension, then this is the event parameter name. If this is an item-scoped dimension, then this is the parameter name found in the eCommerce items array. May only contain alphanumeric and underscore characters, starting with a letter. Max length of 24 characters for user-scoped dimensions, 40 characters for event-scoped dimensions. "scope": "A String", # Required. Immutable. The scope of this dimension. } @@ -155,7 +155,7 @@

Method Details

"description": "A String", # Optional. Description for this custom dimension. Max length of 150 characters. "disallowAdsPersonalization": True or False, # Optional. If set to true, sets this dimension as NPA and excludes it from ads personalization. This is currently only supported by user-scoped custom dimensions. "displayName": "A String", # Required. Display name for this custom dimension as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets. - "name": "A String", # Output only. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension} + "name": "A String", # Identifier. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension} "parameterName": "A String", # Required. Immutable. Tagging parameter name for this custom dimension. If this is a user-scoped dimension, then this is the user property name. If this is an event-scoped dimension, then this is the event parameter name. If this is an item-scoped dimension, then this is the parameter name found in the eCommerce items array. May only contain alphanumeric and underscore characters, starting with a letter. Max length of 24 characters for user-scoped dimensions, 40 characters for event-scoped dimensions. "scope": "A String", # Required. Immutable. The scope of this dimension. } @@ -179,7 +179,7 @@

Method Details

"description": "A String", # Optional. Description for this custom dimension. Max length of 150 characters. "disallowAdsPersonalization": True or False, # Optional. If set to true, sets this dimension as NPA and excludes it from ads personalization. This is currently only supported by user-scoped custom dimensions. "displayName": "A String", # Required. Display name for this custom dimension as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets. - "name": "A String", # Output only. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension} + "name": "A String", # Identifier. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension} "parameterName": "A String", # Required. Immutable. Tagging parameter name for this custom dimension. If this is a user-scoped dimension, then this is the user property name. If this is an event-scoped dimension, then this is the event parameter name. If this is an item-scoped dimension, then this is the parameter name found in the eCommerce items array. May only contain alphanumeric and underscore characters, starting with a letter. Max length of 24 characters for user-scoped dimensions, 40 characters for event-scoped dimensions. "scope": "A String", # Required. Immutable. The scope of this dimension. } @@ -191,8 +191,8 @@

Method Details

Args: parent: string, Required. Example format: properties/1234 (required) - pageSize: integer, The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum). - pageToken: string, A page token, received from a previous `ListCustomDimensions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCustomDimensions` must match the call that provided the page token. + pageSize: integer, Optional. The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum). + pageToken: string, Optional. A page token, received from a previous `ListCustomDimensions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCustomDimensions` must match the call that provided the page token. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -207,7 +207,7 @@

Method Details

"description": "A String", # Optional. Description for this custom dimension. Max length of 150 characters. "disallowAdsPersonalization": True or False, # Optional. If set to true, sets this dimension as NPA and excludes it from ads personalization. This is currently only supported by user-scoped custom dimensions. "displayName": "A String", # Required. Display name for this custom dimension as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets. - "name": "A String", # Output only. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension} + "name": "A String", # Identifier. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension} "parameterName": "A String", # Required. Immutable. Tagging parameter name for this custom dimension. If this is a user-scoped dimension, then this is the user property name. If this is an event-scoped dimension, then this is the event parameter name. If this is an item-scoped dimension, then this is the parameter name found in the eCommerce items array. May only contain alphanumeric and underscore characters, starting with a letter. Max length of 24 characters for user-scoped dimensions, 40 characters for event-scoped dimensions. "scope": "A String", # Required. Immutable. The scope of this dimension. }, @@ -235,7 +235,7 @@

Method Details

Updates a CustomDimension on a property.
 
 Args:
-  name: string, Output only. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension} (required)
+  name: string, Identifier. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension} (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -243,7 +243,7 @@ 

Method Details

"description": "A String", # Optional. Description for this custom dimension. Max length of 150 characters. "disallowAdsPersonalization": True or False, # Optional. If set to true, sets this dimension as NPA and excludes it from ads personalization. This is currently only supported by user-scoped custom dimensions. "displayName": "A String", # Required. Display name for this custom dimension as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets. - "name": "A String", # Output only. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension} + "name": "A String", # Identifier. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension} "parameterName": "A String", # Required. Immutable. Tagging parameter name for this custom dimension. If this is a user-scoped dimension, then this is the user property name. If this is an event-scoped dimension, then this is the event parameter name. If this is an item-scoped dimension, then this is the parameter name found in the eCommerce items array. May only contain alphanumeric and underscore characters, starting with a letter. Max length of 24 characters for user-scoped dimensions, 40 characters for event-scoped dimensions. "scope": "A String", # Required. Immutable. The scope of this dimension. } @@ -261,7 +261,7 @@

Method Details

"description": "A String", # Optional. Description for this custom dimension. Max length of 150 characters. "disallowAdsPersonalization": True or False, # Optional. If set to true, sets this dimension as NPA and excludes it from ads personalization. This is currently only supported by user-scoped custom dimensions. "displayName": "A String", # Required. Display name for this custom dimension as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets. - "name": "A String", # Output only. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension} + "name": "A String", # Identifier. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension} "parameterName": "A String", # Required. Immutable. Tagging parameter name for this custom dimension. If this is a user-scoped dimension, then this is the user property name. If this is an event-scoped dimension, then this is the event parameter name. If this is an item-scoped dimension, then this is the parameter name found in the eCommerce items array. May only contain alphanumeric and underscore characters, starting with a letter. Max length of 24 characters for user-scoped dimensions, 40 characters for event-scoped dimensions. "scope": "A String", # Required. Immutable. The scope of this dimension. }
diff --git a/docs/dyn/analyticsadmin_v1beta.properties.customMetrics.html b/docs/dyn/analyticsadmin_v1beta.properties.customMetrics.html index 54450c6641..d82d25bf85 100644 --- a/docs/dyn/analyticsadmin_v1beta.properties.customMetrics.html +++ b/docs/dyn/analyticsadmin_v1beta.properties.customMetrics.html @@ -138,7 +138,7 @@

Method Details

"description": "A String", # Optional. Description for this custom dimension. Max length of 150 characters. "displayName": "A String", # Required. Display name for this custom metric as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets. "measurementUnit": "A String", # Required. The type for the custom metric's value. - "name": "A String", # Output only. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric} + "name": "A String", # Identifier. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric} "parameterName": "A String", # Required. Immutable. Tagging name for this custom metric. If this is an event-scoped metric, then this is the event parameter name. May only contain alphanumeric and underscore charactes, starting with a letter. Max length of 40 characters for event-scoped metrics. "restrictedMetricType": [ # Optional. Types of restricted data that this metric may contain. Required for metrics with CURRENCY measurement unit. Must be empty for metrics with a non-CURRENCY measurement unit. "A String", @@ -158,7 +158,7 @@

Method Details

"description": "A String", # Optional. Description for this custom dimension. Max length of 150 characters. "displayName": "A String", # Required. Display name for this custom metric as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets. "measurementUnit": "A String", # Required. The type for the custom metric's value. - "name": "A String", # Output only. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric} + "name": "A String", # Identifier. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric} "parameterName": "A String", # Required. Immutable. Tagging name for this custom metric. If this is an event-scoped metric, then this is the event parameter name. May only contain alphanumeric and underscore charactes, starting with a letter. Max length of 40 characters for event-scoped metrics. "restrictedMetricType": [ # Optional. Types of restricted data that this metric may contain. Required for metrics with CURRENCY measurement unit. Must be empty for metrics with a non-CURRENCY measurement unit. "A String", @@ -185,7 +185,7 @@

Method Details

"description": "A String", # Optional. Description for this custom dimension. Max length of 150 characters. "displayName": "A String", # Required. Display name for this custom metric as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets. "measurementUnit": "A String", # Required. The type for the custom metric's value. - "name": "A String", # Output only. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric} + "name": "A String", # Identifier. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric} "parameterName": "A String", # Required. Immutable. Tagging name for this custom metric. If this is an event-scoped metric, then this is the event parameter name. May only contain alphanumeric and underscore charactes, starting with a letter. Max length of 40 characters for event-scoped metrics. "restrictedMetricType": [ # Optional. Types of restricted data that this metric may contain. Required for metrics with CURRENCY measurement unit. Must be empty for metrics with a non-CURRENCY measurement unit. "A String", @@ -216,7 +216,7 @@

Method Details

"description": "A String", # Optional. Description for this custom dimension. Max length of 150 characters. "displayName": "A String", # Required. Display name for this custom metric as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets. "measurementUnit": "A String", # Required. The type for the custom metric's value. - "name": "A String", # Output only. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric} + "name": "A String", # Identifier. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric} "parameterName": "A String", # Required. Immutable. Tagging name for this custom metric. If this is an event-scoped metric, then this is the event parameter name. May only contain alphanumeric and underscore charactes, starting with a letter. Max length of 40 characters for event-scoped metrics. "restrictedMetricType": [ # Optional. Types of restricted data that this metric may contain. Required for metrics with CURRENCY measurement unit. Must be empty for metrics with a non-CURRENCY measurement unit. "A String", @@ -247,7 +247,7 @@

Method Details

Updates a CustomMetric on a property.
 
 Args:
-  name: string, Output only. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric} (required)
+  name: string, Identifier. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric} (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -255,7 +255,7 @@ 

Method Details

"description": "A String", # Optional. Description for this custom dimension. Max length of 150 characters. "displayName": "A String", # Required. Display name for this custom metric as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets. "measurementUnit": "A String", # Required. The type for the custom metric's value. - "name": "A String", # Output only. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric} + "name": "A String", # Identifier. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric} "parameterName": "A String", # Required. Immutable. Tagging name for this custom metric. If this is an event-scoped metric, then this is the event parameter name. May only contain alphanumeric and underscore charactes, starting with a letter. Max length of 40 characters for event-scoped metrics. "restrictedMetricType": [ # Optional. Types of restricted data that this metric may contain. Required for metrics with CURRENCY measurement unit. Must be empty for metrics with a non-CURRENCY measurement unit. "A String", @@ -276,7 +276,7 @@

Method Details

"description": "A String", # Optional. Description for this custom dimension. Max length of 150 characters. "displayName": "A String", # Required. Display name for this custom metric as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets. "measurementUnit": "A String", # Required. The type for the custom metric's value. - "name": "A String", # Output only. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric} + "name": "A String", # Identifier. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric} "parameterName": "A String", # Required. Immutable. Tagging name for this custom metric. If this is an event-scoped metric, then this is the event parameter name. May only contain alphanumeric and underscore charactes, starting with a letter. Max length of 40 characters for event-scoped metrics. "restrictedMetricType": [ # Optional. Types of restricted data that this metric may contain. Required for metrics with CURRENCY measurement unit. Must be empty for metrics with a non-CURRENCY measurement unit. "A String", diff --git a/docs/dyn/analyticsadmin_v1beta.properties.dataStreams.html b/docs/dyn/analyticsadmin_v1beta.properties.dataStreams.html index ffa1353424..8aa92a073f 100644 --- a/docs/dyn/analyticsadmin_v1beta.properties.dataStreams.html +++ b/docs/dyn/analyticsadmin_v1beta.properties.dataStreams.html @@ -126,7 +126,7 @@

Method Details

"bundleId": "A String", # Required. Immutable. The Apple App Store Bundle ID for the app Example: "com.example.myiosapp" "firebaseAppId": "A String", # Output only. ID of the corresponding iOS app in Firebase, if any. This ID can change if the iOS app is deleted and recreated. }, - "name": "A String", # Output only. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: "properties/1000/dataStreams/2000" + "name": "A String", # Identifier. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: "properties/1000/dataStreams/2000" "type": "A String", # Required. Immutable. The type of this DataStream resource. "updateTime": "A String", # Output only. Time when stream payload fields were last updated. "webStreamData": { # Data specific to web streams. # Data specific to web streams. Must be populated if type is WEB_DATA_STREAM. @@ -155,7 +155,7 @@

Method Details

"bundleId": "A String", # Required. Immutable. The Apple App Store Bundle ID for the app Example: "com.example.myiosapp" "firebaseAppId": "A String", # Output only. ID of the corresponding iOS app in Firebase, if any. This ID can change if the iOS app is deleted and recreated. }, - "name": "A String", # Output only. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: "properties/1000/dataStreams/2000" + "name": "A String", # Identifier. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: "properties/1000/dataStreams/2000" "type": "A String", # Required. Immutable. The type of this DataStream resource. "updateTime": "A String", # Output only. Time when stream payload fields were last updated. "webStreamData": { # Data specific to web streams. # Data specific to web streams. Must be populated if type is WEB_DATA_STREAM. @@ -209,7 +209,7 @@

Method Details

"bundleId": "A String", # Required. Immutable. The Apple App Store Bundle ID for the app Example: "com.example.myiosapp" "firebaseAppId": "A String", # Output only. ID of the corresponding iOS app in Firebase, if any. This ID can change if the iOS app is deleted and recreated. }, - "name": "A String", # Output only. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: "properties/1000/dataStreams/2000" + "name": "A String", # Identifier. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: "properties/1000/dataStreams/2000" "type": "A String", # Required. Immutable. The type of this DataStream resource. "updateTime": "A String", # Output only. Time when stream payload fields were last updated. "webStreamData": { # Data specific to web streams. # Data specific to web streams. Must be populated if type is WEB_DATA_STREAM. @@ -249,7 +249,7 @@

Method Details

"bundleId": "A String", # Required. Immutable. The Apple App Store Bundle ID for the app Example: "com.example.myiosapp" "firebaseAppId": "A String", # Output only. ID of the corresponding iOS app in Firebase, if any. This ID can change if the iOS app is deleted and recreated. }, - "name": "A String", # Output only. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: "properties/1000/dataStreams/2000" + "name": "A String", # Identifier. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: "properties/1000/dataStreams/2000" "type": "A String", # Required. Immutable. The type of this DataStream resource. "updateTime": "A String", # Output only. Time when stream payload fields were last updated. "webStreamData": { # Data specific to web streams. # Data specific to web streams. Must be populated if type is WEB_DATA_STREAM. @@ -282,7 +282,7 @@

Method Details

Updates a DataStream on a property.
 
 Args:
-  name: string, Output only. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: "properties/1000/dataStreams/2000" (required)
+  name: string, Identifier. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: "properties/1000/dataStreams/2000" (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -297,7 +297,7 @@ 

Method Details

"bundleId": "A String", # Required. Immutable. The Apple App Store Bundle ID for the app Example: "com.example.myiosapp" "firebaseAppId": "A String", # Output only. ID of the corresponding iOS app in Firebase, if any. This ID can change if the iOS app is deleted and recreated. }, - "name": "A String", # Output only. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: "properties/1000/dataStreams/2000" + "name": "A String", # Identifier. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: "properties/1000/dataStreams/2000" "type": "A String", # Required. Immutable. The type of this DataStream resource. "updateTime": "A String", # Output only. Time when stream payload fields were last updated. "webStreamData": { # Data specific to web streams. # Data specific to web streams. Must be populated if type is WEB_DATA_STREAM. @@ -327,7 +327,7 @@

Method Details

"bundleId": "A String", # Required. Immutable. The Apple App Store Bundle ID for the app Example: "com.example.myiosapp" "firebaseAppId": "A String", # Output only. ID of the corresponding iOS app in Firebase, if any. This ID can change if the iOS app is deleted and recreated. }, - "name": "A String", # Output only. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: "properties/1000/dataStreams/2000" + "name": "A String", # Identifier. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: "properties/1000/dataStreams/2000" "type": "A String", # Required. Immutable. The type of this DataStream resource. "updateTime": "A String", # Output only. Time when stream payload fields were last updated. "webStreamData": { # Data specific to web streams. # Data specific to web streams. Must be populated if type is WEB_DATA_STREAM. diff --git a/docs/dyn/analyticsadmin_v1beta.properties.dataStreams.measurementProtocolSecrets.html b/docs/dyn/analyticsadmin_v1beta.properties.dataStreams.measurementProtocolSecrets.html index 6cdb53da07..473e4d19e6 100644 --- a/docs/dyn/analyticsadmin_v1beta.properties.dataStreams.measurementProtocolSecrets.html +++ b/docs/dyn/analyticsadmin_v1beta.properties.dataStreams.measurementProtocolSecrets.html @@ -112,7 +112,7 @@

Method Details

{ # A secret value used for sending hits to Measurement Protocol. "displayName": "A String", # Required. Human-readable display name for this secret. - "name": "A String", # Output only. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret} + "name": "A String", # Identifier. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret} "secretValue": "A String", # Output only. The measurement protocol secret value. Pass this value to the api_secret field of the Measurement Protocol API when sending hits to this secret's parent property. } @@ -126,7 +126,7 @@

Method Details

{ # A secret value used for sending hits to Measurement Protocol. "displayName": "A String", # Required. Human-readable display name for this secret. - "name": "A String", # Output only. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret} + "name": "A String", # Identifier. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret} "secretValue": "A String", # Output only. The measurement protocol secret value. Pass this value to the api_secret field of the Measurement Protocol API when sending hits to this secret's parent property. }
@@ -165,7 +165,7 @@

Method Details

{ # A secret value used for sending hits to Measurement Protocol. "displayName": "A String", # Required. Human-readable display name for this secret. - "name": "A String", # Output only. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret} + "name": "A String", # Identifier. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret} "secretValue": "A String", # Output only. The measurement protocol secret value. Pass this value to the api_secret field of the Measurement Protocol API when sending hits to this secret's parent property. }
@@ -176,8 +176,8 @@

Method Details

Args: parent: string, Required. The resource name of the parent stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets (required) - pageSize: integer, The maximum number of resources to return. If unspecified, at most 10 resources will be returned. The maximum value is 10. Higher values will be coerced to the maximum. - pageToken: string, A page token, received from a previous `ListMeasurementProtocolSecrets` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListMeasurementProtocolSecrets` must match the call that provided the page token. + pageSize: integer, Optional. The maximum number of resources to return. If unspecified, at most 10 resources will be returned. The maximum value is 10. Higher values will be coerced to the maximum. + pageToken: string, Optional. A page token, received from a previous `ListMeasurementProtocolSecrets` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListMeasurementProtocolSecrets` must match the call that provided the page token. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -190,7 +190,7 @@

Method Details

"measurementProtocolSecrets": [ # A list of secrets for the parent stream specified in the request. { # A secret value used for sending hits to Measurement Protocol. "displayName": "A String", # Required. Human-readable display name for this secret. - "name": "A String", # Output only. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret} + "name": "A String", # Identifier. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret} "secretValue": "A String", # Output only. The measurement protocol secret value. Pass this value to the api_secret field of the Measurement Protocol API when sending hits to this secret's parent property. }, ], @@ -217,13 +217,13 @@

Method Details

Updates a measurement protocol secret.
 
 Args:
-  name: string, Output only. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret} (required)
+  name: string, Identifier. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret} (required)
   body: object, The request body.
     The object takes the form of:
 
 { # A secret value used for sending hits to Measurement Protocol.
   "displayName": "A String", # Required. Human-readable display name for this secret.
-  "name": "A String", # Output only. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}
+  "name": "A String", # Identifier. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}
   "secretValue": "A String", # Output only. The measurement protocol secret value. Pass this value to the api_secret field of the Measurement Protocol API when sending hits to this secret's parent property.
 }
 
@@ -238,7 +238,7 @@ 

Method Details

{ # A secret value used for sending hits to Measurement Protocol. "displayName": "A String", # Required. Human-readable display name for this secret. - "name": "A String", # Output only. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret} + "name": "A String", # Identifier. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret} "secretValue": "A String", # Output only. The measurement protocol secret value. Pass this value to the api_secret field of the Measurement Protocol API when sending hits to this secret's parent property. }
diff --git a/docs/dyn/analyticsadmin_v1beta.properties.firebaseLinks.html b/docs/dyn/analyticsadmin_v1beta.properties.firebaseLinks.html index a68b00ce74..bbfd7c832c 100644 --- a/docs/dyn/analyticsadmin_v1beta.properties.firebaseLinks.html +++ b/docs/dyn/analyticsadmin_v1beta.properties.firebaseLinks.html @@ -106,7 +106,7 @@

Method Details

{ # A link between a Google Analytics property and a Firebase project. "createTime": "A String", # Output only. Time when this FirebaseLink was originally created. - "name": "A String", # Output only. Example format: properties/1234/firebaseLinks/5678 + "name": "A String", # Identifier. Example format: properties/1234/firebaseLinks/5678 "project": "A String", # Immutable. Firebase project resource name. When creating a FirebaseLink, you may provide this resource name using either a project number or project ID. Once this resource has been created, returned FirebaseLinks will always have a project_name that contains a project number. Format: 'projects/{project number}' Example: 'projects/1234' } @@ -120,7 +120,7 @@

Method Details

{ # A link between a Google Analytics property and a Firebase project. "createTime": "A String", # Output only. Time when this FirebaseLink was originally created. - "name": "A String", # Output only. Example format: properties/1234/firebaseLinks/5678 + "name": "A String", # Identifier. Example format: properties/1234/firebaseLinks/5678 "project": "A String", # Immutable. Firebase project resource name. When creating a FirebaseLink, you may provide this resource name using either a project number or project ID. Once this resource has been created, returned FirebaseLinks will always have a project_name that contains a project number. Format: 'projects/{project number}' Example: 'projects/1234' } @@ -149,8 +149,8 @@

Method Details

Args: parent: string, Required. Format: properties/{property_id} Example: `properties/1234` (required) - pageSize: integer, The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum) - pageToken: string, A page token, received from a previous `ListFirebaseLinks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListFirebaseLinks` must match the call that provided the page token. + pageSize: integer, Optional. The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum) + pageToken: string, Optional. A page token, received from a previous `ListFirebaseLinks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListFirebaseLinks` must match the call that provided the page token. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -163,7 +163,7 @@

Method Details

"firebaseLinks": [ # List of FirebaseLinks. This will have at most one value. { # A link between a Google Analytics property and a Firebase project. "createTime": "A String", # Output only. Time when this FirebaseLink was originally created. - "name": "A String", # Output only. Example format: properties/1234/firebaseLinks/5678 + "name": "A String", # Identifier. Example format: properties/1234/firebaseLinks/5678 "project": "A String", # Immutable. Firebase project resource name. When creating a FirebaseLink, you may provide this resource name using either a project number or project ID. Once this resource has been created, returned FirebaseLinks will always have a project_name that contains a project number. Format: 'projects/{project number}' Example: 'projects/1234' }, ], diff --git a/docs/dyn/analyticsadmin_v1beta.properties.googleAdsLinks.html b/docs/dyn/analyticsadmin_v1beta.properties.googleAdsLinks.html index 4e1e1f5047..de83cb56bb 100644 --- a/docs/dyn/analyticsadmin_v1beta.properties.googleAdsLinks.html +++ b/docs/dyn/analyticsadmin_v1beta.properties.googleAdsLinks.html @@ -113,7 +113,7 @@

Method Details

"createTime": "A String", # Output only. Time when this link was originally created. "creatorEmailAddress": "A String", # Output only. Email address of the user that created the link. An empty string will be returned if the email address can't be retrieved. "customerId": "A String", # Immutable. Google Ads customer ID. - "name": "A String", # Output only. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID. + "name": "A String", # Identifier. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID. "updateTime": "A String", # Output only. Time when this link was last updated. } @@ -131,7 +131,7 @@

Method Details

"createTime": "A String", # Output only. Time when this link was originally created. "creatorEmailAddress": "A String", # Output only. Email address of the user that created the link. An empty string will be returned if the email address can't be retrieved. "customerId": "A String", # Immutable. Google Ads customer ID. - "name": "A String", # Output only. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID. + "name": "A String", # Identifier. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID. "updateTime": "A String", # Output only. Time when this link was last updated. } @@ -160,8 +160,8 @@

Method Details

Args: parent: string, Required. Example format: properties/1234 (required) - pageSize: integer, The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum). - pageToken: string, A page token, received from a previous `ListGoogleAdsLinks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListGoogleAdsLinks` must match the call that provided the page token. + pageSize: integer, Optional. The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum). + pageToken: string, Optional. A page token, received from a previous `ListGoogleAdsLinks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListGoogleAdsLinks` must match the call that provided the page token. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -178,7 +178,7 @@

Method Details

"createTime": "A String", # Output only. Time when this link was originally created. "creatorEmailAddress": "A String", # Output only. Email address of the user that created the link. An empty string will be returned if the email address can't be retrieved. "customerId": "A String", # Immutable. Google Ads customer ID. - "name": "A String", # Output only. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID. + "name": "A String", # Identifier. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID. "updateTime": "A String", # Output only. Time when this link was last updated. }, ], @@ -205,7 +205,7 @@

Method Details

Updates a GoogleAdsLink on a property
 
 Args:
-  name: string, Output only. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID. (required)
+  name: string, Identifier. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -215,7 +215,7 @@ 

Method Details

"createTime": "A String", # Output only. Time when this link was originally created. "creatorEmailAddress": "A String", # Output only. Email address of the user that created the link. An empty string will be returned if the email address can't be retrieved. "customerId": "A String", # Immutable. Google Ads customer ID. - "name": "A String", # Output only. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID. + "name": "A String", # Identifier. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID. "updateTime": "A String", # Output only. Time when this link was last updated. } @@ -234,7 +234,7 @@

Method Details

"createTime": "A String", # Output only. Time when this link was originally created. "creatorEmailAddress": "A String", # Output only. Email address of the user that created the link. An empty string will be returned if the email address can't be retrieved. "customerId": "A String", # Immutable. Google Ads customer ID. - "name": "A String", # Output only. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID. + "name": "A String", # Identifier. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID. "updateTime": "A String", # Output only. Time when this link was last updated. }
diff --git a/docs/dyn/analyticsadmin_v1beta.properties.html b/docs/dyn/analyticsadmin_v1beta.properties.html index 321c74766d..7a1c590115 100644 --- a/docs/dyn/analyticsadmin_v1beta.properties.html +++ b/docs/dyn/analyticsadmin_v1beta.properties.html @@ -189,7 +189,7 @@

Method Details

"displayName": "A String", # Required. Human-readable display name for this property. The max allowed display name length is 100 UTF-16 code units. "expireTime": "A String", # Output only. If set, the time at which this trashed property will be permanently deleted. If not set, then this property is not currently in the trash can and is not slated to be deleted. "industryCategory": "A String", # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK - "name": "A String", # Output only. Resource name of this property. Format: properties/{property_id} Example: "properties/1000" + "name": "A String", # Identifier. Resource name of this property. Format: properties/{property_id} Example: "properties/1000" "parent": "A String", # Immutable. Resource name of this property's logical parent. Note: The Property-Moving UI can be used to change the parent. Format: accounts/{account}, properties/{property} Example: "accounts/100", "properties/101" "propertyType": "A String", # Immutable. The property type for this Property resource. When creating a property, if the type is "PROPERTY_TYPE_UNSPECIFIED", then "ORDINARY_PROPERTY" will be implied. "serviceLevel": "A String", # Output only. The Google Analytics service level that applies to this property. @@ -213,7 +213,7 @@

Method Details

"displayName": "A String", # Required. Human-readable display name for this property. The max allowed display name length is 100 UTF-16 code units. "expireTime": "A String", # Output only. If set, the time at which this trashed property will be permanently deleted. If not set, then this property is not currently in the trash can and is not slated to be deleted. "industryCategory": "A String", # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK - "name": "A String", # Output only. Resource name of this property. Format: properties/{property_id} Example: "properties/1000" + "name": "A String", # Identifier. Resource name of this property. Format: properties/{property_id} Example: "properties/1000" "parent": "A String", # Immutable. Resource name of this property's logical parent. Note: The Property-Moving UI can be used to change the parent. Format: accounts/{account}, properties/{property} Example: "accounts/100", "properties/101" "propertyType": "A String", # Immutable. The property type for this Property resource. When creating a property, if the type is "PROPERTY_TYPE_UNSPECIFIED", then "ORDINARY_PROPERTY" will be implied. "serviceLevel": "A String", # Output only. The Google Analytics service level that applies to this property. @@ -244,7 +244,7 @@

Method Details

"displayName": "A String", # Required. Human-readable display name for this property. The max allowed display name length is 100 UTF-16 code units. "expireTime": "A String", # Output only. If set, the time at which this trashed property will be permanently deleted. If not set, then this property is not currently in the trash can and is not slated to be deleted. "industryCategory": "A String", # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK - "name": "A String", # Output only. Resource name of this property. Format: properties/{property_id} Example: "properties/1000" + "name": "A String", # Identifier. Resource name of this property. Format: properties/{property_id} Example: "properties/1000" "parent": "A String", # Immutable. Resource name of this property's logical parent. Note: The Property-Moving UI can be used to change the parent. Format: accounts/{account}, properties/{property} Example: "accounts/100", "properties/101" "propertyType": "A String", # Immutable. The property type for this Property resource. When creating a property, if the type is "PROPERTY_TYPE_UNSPECIFIED", then "ORDINARY_PROPERTY" will be implied. "serviceLevel": "A String", # Output only. The Google Analytics service level that applies to this property. @@ -275,7 +275,7 @@

Method Details

"displayName": "A String", # Required. Human-readable display name for this property. The max allowed display name length is 100 UTF-16 code units. "expireTime": "A String", # Output only. If set, the time at which this trashed property will be permanently deleted. If not set, then this property is not currently in the trash can and is not slated to be deleted. "industryCategory": "A String", # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK - "name": "A String", # Output only. Resource name of this property. Format: properties/{property_id} Example: "properties/1000" + "name": "A String", # Identifier. Resource name of this property. Format: properties/{property_id} Example: "properties/1000" "parent": "A String", # Immutable. Resource name of this property's logical parent. Note: The Property-Moving UI can be used to change the parent. Format: accounts/{account}, properties/{property} Example: "accounts/100", "properties/101" "propertyType": "A String", # Immutable. The property type for this Property resource. When creating a property, if the type is "PROPERTY_TYPE_UNSPECIFIED", then "ORDINARY_PROPERTY" will be implied. "serviceLevel": "A String", # Output only. The Google Analytics service level that applies to this property. @@ -300,7 +300,7 @@

Method Details

{ # Settings values for data retention. This is a singleton resource. "eventDataRetention": "A String", # Required. The length of time that event-level data is retained. - "name": "A String", # Output only. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings + "name": "A String", # Identifier. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings "resetUserDataOnNewActivity": True or False, # If true, reset the retention period for the user identifier with every event from that user. "userDataRetention": "A String", # Required. The length of time that user-level data is retained. } @@ -312,8 +312,8 @@

Method Details

Args: filter: string, Required. An expression for filtering the results of the request. Fields eligible for filtering are: `parent:`(The resource name of the parent account/property) or `ancestor:`(The resource name of the parent account) or `firebase_project:`(The id or number of the linked firebase project). Some examples of filters: ``` | Filter | Description | |-----------------------------|-------------------------------------------| | parent:accounts/123 | The account with account id: 123. | | parent:properties/123 | The property with property id: 123. | | ancestor:accounts/123 | The account with account id: 123. | | firebase_project:project-id | The firebase project with id: project-id. | | firebase_project:123 | The firebase project with number: 123. | ``` - pageSize: integer, The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum) - pageToken: string, A page token, received from a previous `ListProperties` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListProperties` must match the call that provided the page token. + pageSize: integer, Optional. The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum) + pageToken: string, Optional. A page token, received from a previous `ListProperties` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListProperties` must match the call that provided the page token. showDeleted: boolean, Whether to include soft-deleted (ie: "trashed") Properties in the results. Properties can be inspected to determine whether they are deleted or not. x__xgafv: string, V1 error format. Allowed values @@ -334,7 +334,7 @@

Method Details

"displayName": "A String", # Required. Human-readable display name for this property. The max allowed display name length is 100 UTF-16 code units. "expireTime": "A String", # Output only. If set, the time at which this trashed property will be permanently deleted. If not set, then this property is not currently in the trash can and is not slated to be deleted. "industryCategory": "A String", # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK - "name": "A String", # Output only. Resource name of this property. Format: properties/{property_id} Example: "properties/1000" + "name": "A String", # Identifier. Resource name of this property. Format: properties/{property_id} Example: "properties/1000" "parent": "A String", # Immutable. Resource name of this property's logical parent. Note: The Property-Moving UI can be used to change the parent. Format: accounts/{account}, properties/{property} Example: "accounts/100", "properties/101" "propertyType": "A String", # Immutable. The property type for this Property resource. When creating a property, if the type is "PROPERTY_TYPE_UNSPECIFIED", then "ORDINARY_PROPERTY" will be implied. "serviceLevel": "A String", # Output only. The Google Analytics service level that applies to this property. @@ -364,7 +364,7 @@

Method Details

Updates a property.
 
 Args:
-  name: string, Output only. Resource name of this property. Format: properties/{property_id} Example: "properties/1000" (required)
+  name: string, Identifier. Resource name of this property. Format: properties/{property_id} Example: "properties/1000" (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -376,7 +376,7 @@ 

Method Details

"displayName": "A String", # Required. Human-readable display name for this property. The max allowed display name length is 100 UTF-16 code units. "expireTime": "A String", # Output only. If set, the time at which this trashed property will be permanently deleted. If not set, then this property is not currently in the trash can and is not slated to be deleted. "industryCategory": "A String", # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK - "name": "A String", # Output only. Resource name of this property. Format: properties/{property_id} Example: "properties/1000" + "name": "A String", # Identifier. Resource name of this property. Format: properties/{property_id} Example: "properties/1000" "parent": "A String", # Immutable. Resource name of this property's logical parent. Note: The Property-Moving UI can be used to change the parent. Format: accounts/{account}, properties/{property} Example: "accounts/100", "properties/101" "propertyType": "A String", # Immutable. The property type for this Property resource. When creating a property, if the type is "PROPERTY_TYPE_UNSPECIFIED", then "ORDINARY_PROPERTY" will be implied. "serviceLevel": "A String", # Output only. The Google Analytics service level that applies to this property. @@ -401,7 +401,7 @@

Method Details

"displayName": "A String", # Required. Human-readable display name for this property. The max allowed display name length is 100 UTF-16 code units. "expireTime": "A String", # Output only. If set, the time at which this trashed property will be permanently deleted. If not set, then this property is not currently in the trash can and is not slated to be deleted. "industryCategory": "A String", # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK - "name": "A String", # Output only. Resource name of this property. Format: properties/{property_id} Example: "properties/1000" + "name": "A String", # Identifier. Resource name of this property. Format: properties/{property_id} Example: "properties/1000" "parent": "A String", # Immutable. Resource name of this property's logical parent. Note: The Property-Moving UI can be used to change the parent. Format: accounts/{account}, properties/{property} Example: "accounts/100", "properties/101" "propertyType": "A String", # Immutable. The property type for this Property resource. When creating a property, if the type is "PROPERTY_TYPE_UNSPECIFIED", then "ORDINARY_PROPERTY" will be implied. "serviceLevel": "A String", # Output only. The Google Analytics service level that applies to this property. @@ -608,13 +608,13 @@

Method Details

Updates the singleton data retention settings for this property.
 
 Args:
-  name: string, Output only. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings (required)
+  name: string, Identifier. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings (required)
   body: object, The request body.
     The object takes the form of:
 
 { # Settings values for data retention. This is a singleton resource.
   "eventDataRetention": "A String", # Required. The length of time that event-level data is retained.
-  "name": "A String", # Output only. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings
+  "name": "A String", # Identifier. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings
   "resetUserDataOnNewActivity": True or False, # If true, reset the retention period for the user identifier with every event from that user.
   "userDataRetention": "A String", # Required. The length of time that user-level data is retained.
 }
@@ -630,7 +630,7 @@ 

Method Details

{ # Settings values for data retention. This is a singleton resource. "eventDataRetention": "A String", # Required. The length of time that event-level data is retained. - "name": "A String", # Output only. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings + "name": "A String", # Identifier. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings "resetUserDataOnNewActivity": True or False, # If true, reset the retention period for the user identifier with every event from that user. "userDataRetention": "A String", # Required. The length of time that user-level data is retained. }
diff --git a/docs/dyn/analyticsadmin_v1beta.properties.keyEvents.html b/docs/dyn/analyticsadmin_v1beta.properties.keyEvents.html index 78826c7886..0cb9b94246 100644 --- a/docs/dyn/analyticsadmin_v1beta.properties.keyEvents.html +++ b/docs/dyn/analyticsadmin_v1beta.properties.keyEvents.html @@ -197,8 +197,8 @@

Method Details

Args: parent: string, Required. The resource name of the parent property. Example: 'properties/123' (required) - pageSize: integer, The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum) - pageToken: string, A page token, received from a previous `ListKeyEvents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListKeyEvents` must match the call that provided the page token. + pageSize: integer, Optional. The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum) + pageToken: string, Optional. A page token, received from a previous `ListKeyEvents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListKeyEvents` must match the call that provided the page token. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/apigateway_v1.projects.locations.html b/docs/dyn/apigateway_v1.projects.locations.html index 26e43decf8..118586dbb4 100644 --- a/docs/dyn/apigateway_v1.projects.locations.html +++ b/docs/dyn/apigateway_v1.projects.locations.html @@ -97,7 +97,7 @@

Instance Methods

Gets information about a location.

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

-

Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.

+

Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.

list_next()

Retrieves the next page of results.

@@ -136,7 +136,7 @@

Method Details

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
+  
Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
diff --git a/docs/dyn/apigateway_v1beta.projects.locations.html b/docs/dyn/apigateway_v1beta.projects.locations.html
index 4318e66ea6..9634a2dadd 100644
--- a/docs/dyn/apigateway_v1beta.projects.locations.html
+++ b/docs/dyn/apigateway_v1beta.projects.locations.html
@@ -97,7 +97,7 @@ 

Instance Methods

Gets information about a location.

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

-

Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.

+

Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.

list_next()

Retrieves the next page of results.

@@ -136,7 +136,7 @@

Method Details

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
+  
Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
diff --git a/docs/dyn/apigee_v1.organizations.developers.apps.html b/docs/dyn/apigee_v1.organizations.developers.apps.html
index a62b9a90e6..1d31631e77 100644
--- a/docs/dyn/apigee_v1.organizations.developers.apps.html
+++ b/docs/dyn/apigee_v1.organizations.developers.apps.html
@@ -475,8 +475,8 @@ 

Method Details

Args: parent: string, Required. Name of the developer. Use the following structure in your request: `organizations/{org}/developers/{developer_email}` (required) count: string, Number of developer apps to return in the API call. Use with the `startKey` parameter to provide more targeted filtering. The limit is 1000. - expand: boolean, Optional. Specifies whether to expand the results. Set to `true` to expand the results. This query parameter is not valid if you use the `count` or `startKey` query parameters. - shallowExpand: boolean, Optional. Specifies whether to expand the results in shallow mode. Set to `true` to expand the results in shallow mode. + expand: boolean, Optional. Specifies whether to expand the results. Set to `true` to expand the results. This query parameter is not valid if you use the `count` or `startKey` query parameters. **Note**: If set to `true`, the `apigee.developerapps.get` permission is required. + shallowExpand: boolean, Optional. Specifies whether to expand the results in shallow mode. Set to `true` to expand the results in shallow mode. **Note**: If set to `true`, the `apigee.developerapps.get` permission is required. startKey: string, **Note**: Must be used in conjunction with the `count` parameter. Name of the developer app from which to start displaying the list of developer apps. For example, if you're returning 50 developer apps at a time (using the `count` query parameter), you can view developer apps 50-99 by entering the name of the 50th developer app. The developer app name is case sensitive. x__xgafv: string, V1 error format. Allowed values diff --git a/docs/dyn/apigee_v1.organizations.environments.html b/docs/dyn/apigee_v1.organizations.environments.html index e84d37cbea..c46744cfbc 100644 --- a/docs/dyn/apigee_v1.organizations.environments.html +++ b/docs/dyn/apigee_v1.organizations.environments.html @@ -262,7 +262,7 @@

Method Details

"clientIpResolutionConfig": { # Configuration for resolving the client ip. # Optional. The algorithm to resolve IP. This will affect Analytics, API Security, and other features that use the client ip. To remove a client ip resolution config, update the field to an empty value. Example: '{ "clientIpResolutionConfig" = {} }' For more information, see: https://cloud.google.com/apigee/docs/api-platform/system-administration/client-ip-resolution. "headerIndexAlgorithm": { # Resolves the client ip based on a custom header. # Resolves the client ip based on a custom header. "ipHeaderIndex": 42, # Required. The index of the ip in the header. Positive indices 0, 1, 2, 3 chooses indices from the left (first ips) Negative indices -1, -2, -3 chooses indices from the right (last ips) - "ipHeaderName": "A String", # Required. The name of the header to extract the client ip from. We are currently only supporting the X-Forwarded-For header. + "ipHeaderName": "A String", # Required. The name of the header to extract the client ip from. }, }, "createdAt": "A String", # Output only. Creation time of this environment as milliseconds since epoch. @@ -374,7 +374,7 @@

Method Details

"clientIpResolutionConfig": { # Configuration for resolving the client ip. # Optional. The algorithm to resolve IP. This will affect Analytics, API Security, and other features that use the client ip. To remove a client ip resolution config, update the field to an empty value. Example: '{ "clientIpResolutionConfig" = {} }' For more information, see: https://cloud.google.com/apigee/docs/api-platform/system-administration/client-ip-resolution. "headerIndexAlgorithm": { # Resolves the client ip based on a custom header. # Resolves the client ip based on a custom header. "ipHeaderIndex": 42, # Required. The index of the ip in the header. Positive indices 0, 1, 2, 3 chooses indices from the left (first ips) Negative indices -1, -2, -3 chooses indices from the right (last ips) - "ipHeaderName": "A String", # Required. The name of the header to extract the client ip from. We are currently only supporting the X-Forwarded-For header. + "ipHeaderName": "A String", # Required. The name of the header to extract the client ip from. }, }, "createdAt": "A String", # Output only. Creation time of this environment as milliseconds since epoch. @@ -680,22 +680,23 @@

Method Details

}, }, ], - "traceConfig": { # NEXT ID: 9 RuntimeTraceConfig defines the configurations for distributed trace in an environment. # Trace configurations. Contains config for the environment and config overrides for specific API proxies. + "traceConfig": { # NEXT ID: 10 RuntimeTraceConfig defines the configurations for distributed trace in an environment. # Trace configurations. Contains config for the environment and config overrides for specific API proxies. "endpoint": "A String", # Endpoint of the exporter. "exporter": "A String", # Exporter that is used to view the distributed trace captured using OpenCensus. An exporter sends traces to any backend that is capable of consuming them. Recorded spans can be exported by registered exporters. "name": "A String", # Name of the trace config in the following format: `organizations/{org}/environment/{env}/traceConfig` - "openTelemetryProtocolEnabled": True or False, # If `true`, the runtime uses OpenTelemetry Protocol (OTLP) to send trace data. Configuration Requirements (if `open_telemetry_protocol_enabled` is `true`): - Allowed `Exporter`s: `CLOUD_TRACE` or `OPEN_TELEMETRY_COLLECTOR`. - If `Exporter` is `OPEN_TELEMETRY_COLLECTOR`: - `endpoint` refers to a valid OTLP collector URL. - If `Exporter` is `CLOUD_TRACE`: - `endpoint` refers to a valid project ID + "openTelemetryProtocolEnabled": True or False, # Optional. If `true`, the runtime uses OpenTelemetry Protocol (OTLP) to send trace data. Configuration Requirements (if `open_telemetry_protocol_enabled` is `true`): - Allowed `Exporter`s: `CLOUD_TRACE` or `OPEN_TELEMETRY_COLLECTOR`. - If `Exporter` is `OPEN_TELEMETRY_COLLECTOR`: - `endpoint` refers to a valid OTLP collector URL. - If `Exporter` is `CLOUD_TRACE`: - `endpoint` refers to a valid project ID Deprecated: Use trace_protocol instead. "overrides": [ # List of trace configuration overrides for spicific API proxies. - { # NEXT ID: 8 Trace configuration override for a specific API proxy in an environment. + { # NEXT ID: 9 Trace configuration override for a specific API proxy in an environment. "apiProxy": "A String", # Name of the API proxy that will have its trace configuration overridden following format: `organizations/{org}/apis/{api}` "name": "A String", # Name of the trace config override in the following format: `organizations/{org}/environment/{env}/traceConfig/overrides/{override}` - "openTelemetryProtocolEnabled": True or False, # If `true`, the runtime uses OpenTelemetry Protocol (OTLP) to send trace data. Configuration Requirements (if `open_telemetry_protocol_enabled` is `true`): - Allowed `Exporter`s: `CLOUD_TRACE` or `OPEN_TELEMETRY_COLLECTOR`. - If `Exporter` is `OPEN_TELEMETRY_COLLECTOR`: - `endpoint` refers to a valid OTLP collector URL. - If `Exporter` is `CLOUD_TRACE`: - `endpoint` refers to a valid project ID + "openTelemetryProtocolEnabled": True or False, # Optional. If `true`, the runtime uses OpenTelemetry Protocol (OTLP) to send trace data. Configuration Requirements (if `open_telemetry_protocol_enabled` is `true`): - Allowed `Exporter`s: `CLOUD_TRACE` or `OPEN_TELEMETRY_COLLECTOR`. - If `Exporter` is `OPEN_TELEMETRY_COLLECTOR`: - `endpoint` refers to a valid OTLP collector URL. - If `Exporter` is `CLOUD_TRACE`: - `endpoint` refers to a valid project ID Deprecated: Use trace_protocol instead. "revisionCreateTime": "A String", # The timestamp that the revision was created or updated. "revisionId": "A String", # Revision number which can be used by the runtime to detect if the trace config override has changed between two versions. "samplingConfig": { # NEXT ID: 3 RuntimeTraceSamplingConfig represents the detail settings of distributed tracing. Only the fields that are defined in the distributed trace configuration can be overridden using the distribute trace configuration override APIs. # Trace configuration override for a specific API proxy in an environment. "sampler": "A String", # Sampler of distributed tracing. OFF is the default value. "samplingRate": 3.14, # Field sampling rate. This value is only applicable when using the PROBABILITY sampler. The supported values are > 0 and <= 0.5. }, + "traceProtocol": "A String", # Optional. The trace protocol to use. "uid": "A String", # Unique ID for the configuration override. The ID will only change if the override is deleted and recreated. Corresponds to name's "override" field. }, ], @@ -705,6 +706,7 @@

Method Details

"sampler": "A String", # Sampler of distributed tracing. OFF is the default value. "samplingRate": 3.14, # Field sampling rate. This value is only applicable when using the PROBABILITY sampler. The supported values are > 0 and <= 0.5. }, + "traceProtocol": "A String", # Optional. The trace protocol to use. }, "uid": "A String", # Unique ID for the environment configuration. The ID will only change if the environment is deleted and recreated. }
@@ -795,7 +797,7 @@

Method Details

{ # TraceConfig defines the configurations in an environment of distributed trace. "endpoint": "A String", # Required. Endpoint of the exporter. - "exporter": "A String", # Required. Exporter that is used to view the distributed trace captured using OpenCensus. An exporter sends traces to any backend that is capable of consuming them. Recorded spans can be exported by registered exporters. + "exporter": "A String", # Required. Exporter that is used to view the distributed trace captured using the chosen trace protocol. An exporter sends traces to any backend that is capable of consuming them. Recorded spans can be exported by registered exporters. "samplingConfig": { # TraceSamplingConfig represents the detail settings of distributed tracing. Only the fields that are defined in the distributed trace configuration can be overridden using the distribute trace configuration override APIs. # Distributed trace configuration for all API proxies in an environment. You can also override the configuration for a specific API proxy using the distributed trace configuration overrides API. "sampler": "A String", # Sampler of distributed tracing. OFF is the default value. "samplingRate": 3.14, # Field sampling rate. This value is only applicable when using the PROBABILITY sampler. The supported values are > 0 and <= 0.5. @@ -817,7 +819,7 @@

Method Details

"clientIpResolutionConfig": { # Configuration for resolving the client ip. # Optional. The algorithm to resolve IP. This will affect Analytics, API Security, and other features that use the client ip. To remove a client ip resolution config, update the field to an empty value. Example: '{ "clientIpResolutionConfig" = {} }' For more information, see: https://cloud.google.com/apigee/docs/api-platform/system-administration/client-ip-resolution. "headerIndexAlgorithm": { # Resolves the client ip based on a custom header. # Resolves the client ip based on a custom header. "ipHeaderIndex": 42, # Required. The index of the ip in the header. Positive indices 0, 1, 2, 3 chooses indices from the left (first ips) Negative indices -1, -2, -3 chooses indices from the right (last ips) - "ipHeaderName": "A String", # Required. The name of the header to extract the client ip from. We are currently only supporting the X-Forwarded-For header. + "ipHeaderName": "A String", # Required. The name of the header to extract the client ip from. }, }, "createdAt": "A String", # Output only. Creation time of this environment as milliseconds since epoch. @@ -1048,7 +1050,7 @@

Method Details

"clientIpResolutionConfig": { # Configuration for resolving the client ip. # Optional. The algorithm to resolve IP. This will affect Analytics, API Security, and other features that use the client ip. To remove a client ip resolution config, update the field to an empty value. Example: '{ "clientIpResolutionConfig" = {} }' For more information, see: https://cloud.google.com/apigee/docs/api-platform/system-administration/client-ip-resolution. "headerIndexAlgorithm": { # Resolves the client ip based on a custom header. # Resolves the client ip based on a custom header. "ipHeaderIndex": 42, # Required. The index of the ip in the header. Positive indices 0, 1, 2, 3 chooses indices from the left (first ips) Negative indices -1, -2, -3 chooses indices from the right (last ips) - "ipHeaderName": "A String", # Required. The name of the header to extract the client ip from. We are currently only supporting the X-Forwarded-For header. + "ipHeaderName": "A String", # Required. The name of the header to extract the client ip from. }, }, "createdAt": "A String", # Output only. Creation time of this environment as milliseconds since epoch. @@ -1089,7 +1091,7 @@

Method Details

"clientIpResolutionConfig": { # Configuration for resolving the client ip. # Optional. The algorithm to resolve IP. This will affect Analytics, API Security, and other features that use the client ip. To remove a client ip resolution config, update the field to an empty value. Example: '{ "clientIpResolutionConfig" = {} }' For more information, see: https://cloud.google.com/apigee/docs/api-platform/system-administration/client-ip-resolution. "headerIndexAlgorithm": { # Resolves the client ip based on a custom header. # Resolves the client ip based on a custom header. "ipHeaderIndex": 42, # Required. The index of the ip in the header. Positive indices 0, 1, 2, 3 chooses indices from the left (first ips) Negative indices -1, -2, -3 chooses indices from the right (last ips) - "ipHeaderName": "A String", # Required. The name of the header to extract the client ip from. We are currently only supporting the X-Forwarded-For header. + "ipHeaderName": "A String", # Required. The name of the header to extract the client ip from. }, }, "createdAt": "A String", # Output only. Creation time of this environment as milliseconds since epoch. @@ -1208,7 +1210,7 @@

Method Details

"clientIpResolutionConfig": { # Configuration for resolving the client ip. # Optional. The algorithm to resolve IP. This will affect Analytics, API Security, and other features that use the client ip. To remove a client ip resolution config, update the field to an empty value. Example: '{ "clientIpResolutionConfig" = {} }' For more information, see: https://cloud.google.com/apigee/docs/api-platform/system-administration/client-ip-resolution. "headerIndexAlgorithm": { # Resolves the client ip based on a custom header. # Resolves the client ip based on a custom header. "ipHeaderIndex": 42, # Required. The index of the ip in the header. Positive indices 0, 1, 2, 3 chooses indices from the left (first ips) Negative indices -1, -2, -3 chooses indices from the right (last ips) - "ipHeaderName": "A String", # Required. The name of the header to extract the client ip from. We are currently only supporting the X-Forwarded-For header. + "ipHeaderName": "A String", # Required. The name of the header to extract the client ip from. }, }, "createdAt": "A String", # Output only. Creation time of this environment as milliseconds since epoch. @@ -1249,7 +1251,7 @@

Method Details

"clientIpResolutionConfig": { # Configuration for resolving the client ip. # Optional. The algorithm to resolve IP. This will affect Analytics, API Security, and other features that use the client ip. To remove a client ip resolution config, update the field to an empty value. Example: '{ "clientIpResolutionConfig" = {} }' For more information, see: https://cloud.google.com/apigee/docs/api-platform/system-administration/client-ip-resolution. "headerIndexAlgorithm": { # Resolves the client ip based on a custom header. # Resolves the client ip based on a custom header. "ipHeaderIndex": 42, # Required. The index of the ip in the header. Positive indices 0, 1, 2, 3 chooses indices from the left (first ips) Negative indices -1, -2, -3 chooses indices from the right (last ips) - "ipHeaderName": "A String", # Required. The name of the header to extract the client ip from. We are currently only supporting the X-Forwarded-For header. + "ipHeaderName": "A String", # Required. The name of the header to extract the client ip from. }, }, "createdAt": "A String", # Output only. Creation time of this environment as milliseconds since epoch. @@ -1320,7 +1322,7 @@

Method Details

{ # TraceConfig defines the configurations in an environment of distributed trace. "endpoint": "A String", # Required. Endpoint of the exporter. - "exporter": "A String", # Required. Exporter that is used to view the distributed trace captured using OpenCensus. An exporter sends traces to any backend that is capable of consuming them. Recorded spans can be exported by registered exporters. + "exporter": "A String", # Required. Exporter that is used to view the distributed trace captured using the chosen trace protocol. An exporter sends traces to any backend that is capable of consuming them. Recorded spans can be exported by registered exporters. "samplingConfig": { # TraceSamplingConfig represents the detail settings of distributed tracing. Only the fields that are defined in the distributed trace configuration can be overridden using the distribute trace configuration override APIs. # Distributed trace configuration for all API proxies in an environment. You can also override the configuration for a specific API proxy using the distributed trace configuration overrides API. "sampler": "A String", # Sampler of distributed tracing. OFF is the default value. "samplingRate": 3.14, # Field sampling rate. This value is only applicable when using the PROBABILITY sampler. The supported values are > 0 and <= 0.5. @@ -1338,7 +1340,7 @@

Method Details

{ # TraceConfig defines the configurations in an environment of distributed trace. "endpoint": "A String", # Required. Endpoint of the exporter. - "exporter": "A String", # Required. Exporter that is used to view the distributed trace captured using OpenCensus. An exporter sends traces to any backend that is capable of consuming them. Recorded spans can be exported by registered exporters. + "exporter": "A String", # Required. Exporter that is used to view the distributed trace captured using the chosen trace protocol. An exporter sends traces to any backend that is capable of consuming them. Recorded spans can be exported by registered exporters. "samplingConfig": { # TraceSamplingConfig represents the detail settings of distributed tracing. Only the fields that are defined in the distributed trace configuration can be overridden using the distribute trace configuration override APIs. # Distributed trace configuration for all API proxies in an environment. You can also override the configuration for a specific API proxy using the distributed trace configuration overrides API. "sampler": "A String", # Sampler of distributed tracing. OFF is the default value. "samplingRate": 3.14, # Field sampling rate. This value is only applicable when using the PROBABILITY sampler. The supported values are > 0 and <= 0.5. diff --git a/docs/dyn/apim_v1alpha.projects.locations.html b/docs/dyn/apim_v1alpha.projects.locations.html index 144b410282..05a944cd9b 100644 --- a/docs/dyn/apim_v1alpha.projects.locations.html +++ b/docs/dyn/apim_v1alpha.projects.locations.html @@ -100,7 +100,7 @@

Instance Methods

GetEntitlement returns the entitlement for the provided project.

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

-

Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.

+

Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.

listApiObservationTags(parent, pageSize=None, pageToken=None, x__xgafv=None)

ListApiObservationTags lists all extant tags on any observation in the given project.

@@ -168,7 +168,7 @@

Method Details

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
+  
Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
diff --git a/docs/dyn/apphub_v1.projects.locations.html b/docs/dyn/apphub_v1.projects.locations.html
index 5a51437375..a0dc53c32b 100644
--- a/docs/dyn/apphub_v1.projects.locations.html
+++ b/docs/dyn/apphub_v1.projects.locations.html
@@ -118,7 +118,7 @@ 

Instance Methods

Gets a Boundary.

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

-

Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.

+

Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.

list_next()

Retrieves the next page of results.

@@ -210,7 +210,7 @@

Method Details

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
+  
Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
diff --git a/docs/dyn/apphub_v1alpha.projects.locations.html b/docs/dyn/apphub_v1alpha.projects.locations.html
index 63ce8ef065..6d82f090ea 100644
--- a/docs/dyn/apphub_v1alpha.projects.locations.html
+++ b/docs/dyn/apphub_v1alpha.projects.locations.html
@@ -118,7 +118,7 @@ 

Instance Methods

Gets a Boundary.

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

-

Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.

+

Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.

list_next()

Retrieves the next page of results.

@@ -210,7 +210,7 @@

Method Details

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
+  
Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
diff --git a/docs/dyn/backupdr_v1.projects.locations.backupPlans.html b/docs/dyn/backupdr_v1.projects.locations.backupPlans.html
index f52d9d84fe..ac99d4644c 100644
--- a/docs/dyn/backupdr_v1.projects.locations.backupPlans.html
+++ b/docs/dyn/backupdr_v1.projects.locations.backupPlans.html
@@ -146,6 +146,9 @@ 

Method Details

], "backupVault": "A String", # Required. Resource name of backup vault which will be used as storage location for backups. Format: projects/{project}/locations/{location}/backupVaults/{backupvault} "backupVaultServiceAccount": "A String", # Output only. The Google Cloud service account to be used by the BackupVault for taking backups. Specify the email address of the Backup Vault Service Account. + "computeInstanceBackupPlanProperties": { # --- ComputeInstanceBackupPlanProperties Message --- # Optional. Defines optional properties specific to backups of disk-based resources, such as Compute Engine. This includes settings like whether to perform a guest flush. + "guestFlush": True or False, # Optional. Indicates whether to perform a guest flush operation before taking a compute backup. When set to false, the system will create crash-consistent backups. Default value is false. + }, "createTime": "A String", # Output only. When the `BackupPlan` was created. "description": "A String", # Optional. The description of the `BackupPlan` resource. The description allows for additional details about `BackupPlan` and its use cases to be provided. An example description is the following: "This is a backup plan that performs a daily backup at 6pm and retains data for 3 months". The description must be at most 2048 characters. "diskBackupPlanProperties": { # --- DiskBackupPlanProperties Message --- # Optional. Defines optional properties specific to backups of disk-based resources, such as Compute Engine Persistent Disks. This includes settings like whether to perform a guest flush. @@ -280,6 +283,9 @@

Method Details

], "backupVault": "A String", # Required. Resource name of backup vault which will be used as storage location for backups. Format: projects/{project}/locations/{location}/backupVaults/{backupvault} "backupVaultServiceAccount": "A String", # Output only. The Google Cloud service account to be used by the BackupVault for taking backups. Specify the email address of the Backup Vault Service Account. + "computeInstanceBackupPlanProperties": { # --- ComputeInstanceBackupPlanProperties Message --- # Optional. Defines optional properties specific to backups of disk-based resources, such as Compute Engine. This includes settings like whether to perform a guest flush. + "guestFlush": True or False, # Optional. Indicates whether to perform a guest flush operation before taking a compute backup. When set to false, the system will create crash-consistent backups. Default value is false. + }, "createTime": "A String", # Output only. When the `BackupPlan` was created. "description": "A String", # Optional. The description of the `BackupPlan` resource. The description allows for additional details about `BackupPlan` and its use cases to be provided. An example description is the following: "This is a backup plan that performs a daily backup at 6pm and retains data for 3 months". The description must be at most 2048 characters. "diskBackupPlanProperties": { # --- DiskBackupPlanProperties Message --- # Optional. Defines optional properties specific to backups of disk-based resources, such as Compute Engine Persistent Disks. This includes settings like whether to perform a guest flush. @@ -354,6 +360,9 @@

Method Details

], "backupVault": "A String", # Required. Resource name of backup vault which will be used as storage location for backups. Format: projects/{project}/locations/{location}/backupVaults/{backupvault} "backupVaultServiceAccount": "A String", # Output only. The Google Cloud service account to be used by the BackupVault for taking backups. Specify the email address of the Backup Vault Service Account. + "computeInstanceBackupPlanProperties": { # --- ComputeInstanceBackupPlanProperties Message --- # Optional. Defines optional properties specific to backups of disk-based resources, such as Compute Engine. This includes settings like whether to perform a guest flush. + "guestFlush": True or False, # Optional. Indicates whether to perform a guest flush operation before taking a compute backup. When set to false, the system will create crash-consistent backups. Default value is false. + }, "createTime": "A String", # Output only. When the `BackupPlan` was created. "description": "A String", # Optional. The description of the `BackupPlan` resource. The description allows for additional details about `BackupPlan` and its use cases to be provided. An example description is the following: "This is a backup plan that performs a daily backup at 6pm and retains data for 3 months". The description must be at most 2048 characters. "diskBackupPlanProperties": { # --- DiskBackupPlanProperties Message --- # Optional. Defines optional properties specific to backups of disk-based resources, such as Compute Engine Persistent Disks. This includes settings like whether to perform a guest flush. @@ -437,6 +446,9 @@

Method Details

], "backupVault": "A String", # Required. Resource name of backup vault which will be used as storage location for backups. Format: projects/{project}/locations/{location}/backupVaults/{backupvault} "backupVaultServiceAccount": "A String", # Output only. The Google Cloud service account to be used by the BackupVault for taking backups. Specify the email address of the Backup Vault Service Account. + "computeInstanceBackupPlanProperties": { # --- ComputeInstanceBackupPlanProperties Message --- # Optional. Defines optional properties specific to backups of disk-based resources, such as Compute Engine. This includes settings like whether to perform a guest flush. + "guestFlush": True or False, # Optional. Indicates whether to perform a guest flush operation before taking a compute backup. When set to false, the system will create crash-consistent backups. Default value is false. + }, "createTime": "A String", # Output only. When the `BackupPlan` was created. "description": "A String", # Optional. The description of the `BackupPlan` resource. The description allows for additional details about `BackupPlan` and its use cases to be provided. An example description is the following: "This is a backup plan that performs a daily backup at 6pm and retains data for 3 months". The description must be at most 2048 characters. "diskBackupPlanProperties": { # --- DiskBackupPlanProperties Message --- # Optional. Defines optional properties specific to backups of disk-based resources, such as Compute Engine Persistent Disks. This includes settings like whether to perform a guest flush. diff --git a/docs/dyn/backupdr_v1.projects.locations.backupPlans.revisions.html b/docs/dyn/backupdr_v1.projects.locations.backupPlans.revisions.html index 06583876c1..0aa3e26939 100644 --- a/docs/dyn/backupdr_v1.projects.locations.backupPlans.revisions.html +++ b/docs/dyn/backupdr_v1.projects.locations.backupPlans.revisions.html @@ -138,6 +138,9 @@

Method Details

], "backupVault": "A String", # Required. Resource name of backup vault which will be used as storage location for backups. Format: projects/{project}/locations/{location}/backupVaults/{backupvault} "backupVaultServiceAccount": "A String", # Output only. The Google Cloud service account to be used by the BackupVault for taking backups. Specify the email address of the Backup Vault Service Account. + "computeInstanceBackupPlanProperties": { # --- ComputeInstanceBackupPlanProperties Message --- # Optional. Defines optional properties specific to backups of disk-based resources, such as Compute Engine. This includes settings like whether to perform a guest flush. + "guestFlush": True or False, # Optional. Indicates whether to perform a guest flush operation before taking a compute backup. When set to false, the system will create crash-consistent backups. Default value is false. + }, "createTime": "A String", # Output only. When the `BackupPlan` was created. "description": "A String", # Optional. The description of the `BackupPlan` resource. The description allows for additional details about `BackupPlan` and its use cases to be provided. An example description is the following: "This is a backup plan that performs a daily backup at 6pm and retains data for 3 months". The description must be at most 2048 characters. "diskBackupPlanProperties": { # --- DiskBackupPlanProperties Message --- # Optional. Defines optional properties specific to backups of disk-based resources, such as Compute Engine Persistent Disks. This includes settings like whether to perform a guest flush. @@ -216,6 +219,9 @@

Method Details

], "backupVault": "A String", # Required. Resource name of backup vault which will be used as storage location for backups. Format: projects/{project}/locations/{location}/backupVaults/{backupvault} "backupVaultServiceAccount": "A String", # Output only. The Google Cloud service account to be used by the BackupVault for taking backups. Specify the email address of the Backup Vault Service Account. + "computeInstanceBackupPlanProperties": { # --- ComputeInstanceBackupPlanProperties Message --- # Optional. Defines optional properties specific to backups of disk-based resources, such as Compute Engine. This includes settings like whether to perform a guest flush. + "guestFlush": True or False, # Optional. Indicates whether to perform a guest flush operation before taking a compute backup. When set to false, the system will create crash-consistent backups. Default value is false. + }, "createTime": "A String", # Output only. When the `BackupPlan` was created. "description": "A String", # Optional. The description of the `BackupPlan` resource. The description allows for additional details about `BackupPlan` and its use cases to be provided. An example description is the following: "This is a backup plan that performs a daily backup at 6pm and retains data for 3 months". The description must be at most 2048 characters. "diskBackupPlanProperties": { # --- DiskBackupPlanProperties Message --- # Optional. Defines optional properties specific to backups of disk-based resources, such as Compute Engine Persistent Disks. This includes settings like whether to perform a guest flush. diff --git a/docs/dyn/backupdr_v1.projects.locations.backupVaults.dataSources.backups.html b/docs/dyn/backupdr_v1.projects.locations.backupVaults.dataSources.backups.html index ec15e97216..97718e7bf7 100644 --- a/docs/dyn/backupdr_v1.projects.locations.backupVaults.dataSources.backups.html +++ b/docs/dyn/backupdr_v1.projects.locations.backupVaults.dataSources.backups.html @@ -254,6 +254,7 @@

Method Details

"acceleratorType": "A String", # Optional. Full or partial URL of the accelerator type resource to attach to this instance. }, ], + "guestFlush": True or False, # Optional. Indicates whether to perform a guest flush operation before taking a compute backup. When set to false, the system will create crash-consistent backups. Default value is false. "keyRevocationActionType": "A String", # KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified. "labels": { # Labels to apply to instances that are created from these properties. "a_key": "A String", @@ -551,6 +552,7 @@

Method Details

"acceleratorType": "A String", # Optional. Full or partial URL of the accelerator type resource to attach to this instance. }, ], + "guestFlush": True or False, # Optional. Indicates whether to perform a guest flush operation before taking a compute backup. When set to false, the system will create crash-consistent backups. Default value is false. "keyRevocationActionType": "A String", # KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified. "labels": { # Labels to apply to instances that are created from these properties. "a_key": "A String", @@ -837,6 +839,7 @@

Method Details

"acceleratorType": "A String", # Optional. Full or partial URL of the accelerator type resource to attach to this instance. }, ], + "guestFlush": True or False, # Optional. Indicates whether to perform a guest flush operation before taking a compute backup. When set to false, the system will create crash-consistent backups. Default value is false. "keyRevocationActionType": "A String", # KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified. "labels": { # Labels to apply to instances that are created from these properties. "a_key": "A String", @@ -1127,6 +1130,7 @@

Method Details

"acceleratorType": "A String", # Optional. Full or partial URL of the accelerator type resource to attach to this instance. }, ], + "guestFlush": True or False, # Optional. Indicates whether to perform a guest flush operation before taking a compute backup. When set to false, the system will create crash-consistent backups. Default value is false. "keyRevocationActionType": "A String", # KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified. "labels": { # Labels to apply to instances that are created from these properties. "a_key": "A String", diff --git a/docs/dyn/backupdr_v1.projects.locations.html b/docs/dyn/backupdr_v1.projects.locations.html index 3aa236736f..6a61375d13 100644 --- a/docs/dyn/backupdr_v1.projects.locations.html +++ b/docs/dyn/backupdr_v1.projects.locations.html @@ -130,7 +130,7 @@

Instance Methods

Gets the Trial state for a given project

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

-

Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.

+

Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.

list_next()

Retrieves the next page of results.

@@ -192,7 +192,7 @@

Method Details

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
+  
Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
diff --git a/docs/dyn/bigtableadmin_v2.projects.instances.appProfiles.html b/docs/dyn/bigtableadmin_v2.projects.instances.appProfiles.html
index 702e9653d1..08b9e3c1b6 100644
--- a/docs/dyn/bigtableadmin_v2.projects.instances.appProfiles.html
+++ b/docs/dyn/bigtableadmin_v2.projects.instances.appProfiles.html
@@ -130,6 +130,8 @@ 

Method Details

"clusterId": "A String", # The cluster to which read/write requests should be routed. }, "standardIsolation": { # Standard options for isolating this app profile's traffic from other use cases. # The standard options used for isolating this app profile's traffic from other use cases. + "memoryConfig": { # If set, eligible single-row requests (currently limited to ReadRows) using this app profile will be routed to the memory layer. All eligible writes populate the memory layer. MemoryConfig can only be set if the AppProfile uses single cluster routing and the configured cluster has a memory layer enabled. # Optional. The memory config to use for requests sent using this app profile. + }, "priority": "A String", # The priority of requests sent using this app profile. }, } @@ -164,6 +166,8 @@

Method Details

"clusterId": "A String", # The cluster to which read/write requests should be routed. }, "standardIsolation": { # Standard options for isolating this app profile's traffic from other use cases. # The standard options used for isolating this app profile's traffic from other use cases. + "memoryConfig": { # If set, eligible single-row requests (currently limited to ReadRows) using this app profile will be routed to the memory layer. All eligible writes populate the memory layer. MemoryConfig can only be set if the AppProfile uses single cluster routing and the configured cluster has a memory layer enabled. # Optional. The memory config to use for requests sent using this app profile. + }, "priority": "A String", # The priority of requests sent using this app profile. }, }
@@ -222,6 +226,8 @@

Method Details

"clusterId": "A String", # The cluster to which read/write requests should be routed. }, "standardIsolation": { # Standard options for isolating this app profile's traffic from other use cases. # The standard options used for isolating this app profile's traffic from other use cases. + "memoryConfig": { # If set, eligible single-row requests (currently limited to ReadRows) using this app profile will be routed to the memory layer. All eligible writes populate the memory layer. MemoryConfig can only be set if the AppProfile uses single cluster routing and the configured cluster has a memory layer enabled. # Optional. The memory config to use for requests sent using this app profile. + }, "priority": "A String", # The priority of requests sent using this app profile. }, }
@@ -265,6 +271,8 @@

Method Details

"clusterId": "A String", # The cluster to which read/write requests should be routed. }, "standardIsolation": { # Standard options for isolating this app profile's traffic from other use cases. # The standard options used for isolating this app profile's traffic from other use cases. + "memoryConfig": { # If set, eligible single-row requests (currently limited to ReadRows) using this app profile will be routed to the memory layer. All eligible writes populate the memory layer. MemoryConfig can only be set if the AppProfile uses single cluster routing and the configured cluster has a memory layer enabled. # Optional. The memory config to use for requests sent using this app profile. + }, "priority": "A String", # The priority of requests sent using this app profile. }, }, @@ -319,6 +327,8 @@

Method Details

"clusterId": "A String", # The cluster to which read/write requests should be routed. }, "standardIsolation": { # Standard options for isolating this app profile's traffic from other use cases. # The standard options used for isolating this app profile's traffic from other use cases. + "memoryConfig": { # If set, eligible single-row requests (currently limited to ReadRows) using this app profile will be routed to the memory layer. All eligible writes populate the memory layer. MemoryConfig can only be set if the AppProfile uses single cluster routing and the configured cluster has a memory layer enabled. # Optional. The memory config to use for requests sent using this app profile. + }, "priority": "A String", # The priority of requests sent using this app profile. }, } diff --git a/docs/dyn/bigtableadmin_v2.projects.instances.clusters.html b/docs/dyn/bigtableadmin_v2.projects.instances.clusters.html index 78820cefdf..839e631e83 100644 --- a/docs/dyn/bigtableadmin_v2.projects.instances.clusters.html +++ b/docs/dyn/bigtableadmin_v2.projects.instances.clusters.html @@ -84,6 +84,11 @@

Instance Methods

Returns the hotTablets Resource.

+

+ memoryLayers() +

+

Returns the memoryLayers Resource.

+

close()

Close httplib2 connections.

@@ -96,6 +101,9 @@

Instance Methods

get(name, x__xgafv=None)

Gets information about a cluster.

+

+ getMemoryLayer(name, x__xgafv=None)

+

Gets information about the memory layer of a cluster.

list(parent, pageToken=None, x__xgafv=None)

Lists information about clusters in an instance.

@@ -108,6 +116,9 @@

Instance Methods

update(name, body=None, x__xgafv=None)

Updates a cluster within an instance. Note that UpdateCluster does not support updating cluster_config.cluster_autoscaling_config. In order to update it, you must use PartialUpdateCluster.

+

+ updateMemoryLayer(name, body=None, updateMask=None, x__xgafv=None)

+

Updates the memory layer of a cluster. To enable the memory layer, set the memory_config. To disable the memory layer, unset the memory_config.

Method Details

close() @@ -234,6 +245,30 @@

Method Details

}
+
+ getMemoryLayer(name, x__xgafv=None) +
Gets information about the memory layer of a cluster.
+
+Args:
+  name: string, Required. The unique name of the requested cluster's memory layer. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}/memoryLayer`. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The memory layer of a cluster. A memory layer serves reads from memory without hitting the backing persistent data store.
+  "etag": "A String", # Optional. The etag for this memory layer. This may be sent on update requests to ensure that the client has an up-to-date value before proceeding. The server returns an ABORTED error on a mismatched etag.
+  "memoryConfig": { # Configuration of a memory layer. # The configuration of this memory layer. Set an empty `memory_config` to enable the memory layer. Unset this to disable the memory layer.
+    "storageSizeGib": 42, # Output only. Reporting the current size of the memory layer in GiB.
+  },
+  "name": "A String", # Identifier. Name of the memory layer. This is always: "projects/{project}/instances/{instance}/clusters/{cluster}/memoryLayer".
+  "state": "A String", # Output only. The current state of the memory layer.
+}
+
+
list(parent, pageToken=None, x__xgafv=None)
Lists information about clusters in an instance.
@@ -421,4 +456,52 @@ 

Method Details

}
+
+ updateMemoryLayer(name, body=None, updateMask=None, x__xgafv=None) +
Updates the memory layer of a cluster. To enable the memory layer, set the memory_config. To disable the memory layer, unset the memory_config.
+
+Args:
+  name: string, Identifier. Name of the memory layer. This is always: "projects/{project}/instances/{instance}/clusters/{cluster}/memoryLayer". (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The memory layer of a cluster. A memory layer serves reads from memory without hitting the backing persistent data store.
+  "etag": "A String", # Optional. The etag for this memory layer. This may be sent on update requests to ensure that the client has an up-to-date value before proceeding. The server returns an ABORTED error on a mismatched etag.
+  "memoryConfig": { # Configuration of a memory layer. # The configuration of this memory layer. Set an empty `memory_config` to enable the memory layer. Unset this to disable the memory layer.
+    "storageSizeGib": 42, # Output only. Reporting the current size of the memory layer in GiB.
+  },
+  "name": "A String", # Identifier. Name of the memory layer. This is always: "projects/{project}/instances/{instance}/clusters/{cluster}/memoryLayer".
+  "state": "A String", # Output only. The current state of the memory layer.
+}
+
+  updateMask: string, Optional. The list of fields to update.
+  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, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/bigtableadmin_v2.projects.instances.clusters.memoryLayers.html b/docs/dyn/bigtableadmin_v2.projects.instances.clusters.memoryLayers.html new file mode 100644 index 0000000000..b22a14e2a7 --- /dev/null +++ b/docs/dyn/bigtableadmin_v2.projects.instances.clusters.memoryLayers.html @@ -0,0 +1,140 @@ + + + +

Cloud Bigtable Admin API . projects . instances . clusters . memoryLayers

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ list(parent, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists information about memory layers.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) +
Lists information about memory layers.
+
+Args:
+  parent: string, Required. The unique name of the cluster for which a list of memory layers is requested. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}`. Use `{cluster} = '-'` to list MemoryLayers for all Clusters in an instance, e.g., `projects/myproject/instances/myinstance/clusters/-`. (required)
+  pageSize: integer, Optional. The maximum number of memory layers to return. The service may return fewer than this value.
+  pageToken: string, Optional. A page token, received from a previous `ListMemoryLayers` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListMemoryLayers` must match the call that provided the page token.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for BigtableInstanceAdmin.ListMemoryLayers.
+  "failedLocations": [ # Locations from which MemoryLayer information could not be retrieved, due to an outage or some other transient condition. MemoryLayers from these locations may be missing from `memory_layers`, or may only have partial information returned. Values are of the form `projects//locations/`
+    "A String",
+  ],
+  "memoryLayers": [ # The list of requested memory layers.
+    { # The memory layer of a cluster. A memory layer serves reads from memory without hitting the backing persistent data store.
+      "etag": "A String", # Optional. The etag for this memory layer. This may be sent on update requests to ensure that the client has an up-to-date value before proceeding. The server returns an ABORTED error on a mismatched etag.
+      "memoryConfig": { # Configuration of a memory layer. # The configuration of this memory layer. Set an empty `memory_config` to enable the memory layer. Unset this to disable the memory layer.
+        "storageSizeGib": 42, # Output only. Reporting the current size of the memory layer in GiB.
+      },
+      "name": "A String", # Identifier. Name of the memory layer. This is always: "projects/{project}/instances/{instance}/clusters/{cluster}/memoryLayer".
+      "state": "A String", # Output only. The current state of the memory layer.
+    },
+  ],
+  "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/bigtableadmin_v2.projects.instances.tables.html b/docs/dyn/bigtableadmin_v2.projects.instances.tables.html index 6444de439e..c899763fac 100644 --- a/docs/dyn/bigtableadmin_v2.projects.instances.tables.html +++ b/docs/dyn/bigtableadmin_v2.projects.instances.tables.html @@ -186,6 +186,9 @@

Method Details

"table": { # A collection of user data indexed by row, column, and timestamp. Each table is served using the resources of its parent cluster. # Required. The Table to create. "automatedBackupPolicy": { # Defines an automated backup policy for a table # If specified, automated backups are enabled for this table. Otherwise, automated backups are disabled. "frequency": "A String", # How frequently automated backups should occur. The only supported value at this time is 24 hours. An undefined frequency is treated as 24 hours. + "locations": [ # Optional. A list of Cloud Bigtable zones where automated backups are allowed to be created. If empty, automated backups will be created in all zones of the instance. Locations are in the format `projects/{project}/locations/{zone}`. This field can only set for tables in Enterprise Plus instances. + "A String", + ], "retentionPeriod": "A String", # Required. How long the automated backups should be retained. Values must be at least 3 days and at most 90 days. }, "changeStreamConfig": { # Change stream configuration. # If specified, enable the change stream on this table. Otherwise, the change stream is disabled and the change stream is not retained. @@ -271,6 +274,14 @@

Method Details

}, "geographyType": { # A geography type, representing a point or region on Earth. The value is stored in `Value.bytes_value` as Well-Known Binary (WKB) bytes. # Geography }, + "int32Type": { # Int32 Values of type `Int32` are stored in `Value.int_value`. # Int32 + "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. + "bigEndianBytes": { # Encodes the value as a 4-byte big-endian two's complement value. Sorted mode: non-negative values are supported. Distinct mode: all values are supported. Compatible with: - BigQuery `BINARY` encoding - HBase `Bytes.toBytes` - Java `ByteBuffer.putInt()` with `ByteOrder.BIG_ENDIAN` # Use `BigEndianBytes` encoding. + }, + "orderedCodeBytes": { # Encodes the value in a variable length binary format of up to 5 bytes. Values that are closer to zero use fewer bytes. Sorted mode: all values are supported. Distinct mode: all values are supported. # Use `OrderedCodeBytes` encoding. + }, + }, + }, "int64Type": { # Int64 Values of type `Int64` are stored in `Value.int_value`. # Int64 "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. "bigEndianBytes": { # Encodes the value as an 8-byte big-endian two's complement value. Sorted mode: non-negative values are supported. Distinct mode: all values are supported. Compatible with: - BigQuery `BINARY` encoding - HBase `Bytes.toBytes` - Java `ByteBuffer.putLong()` with `ByteOrder.BIG_ENDIAN` # Use `BigEndianBytes` encoding. @@ -396,6 +407,9 @@

Method Details

{ # A collection of user data indexed by row, column, and timestamp. Each table is served using the resources of its parent cluster. "automatedBackupPolicy": { # Defines an automated backup policy for a table # If specified, automated backups are enabled for this table. Otherwise, automated backups are disabled. "frequency": "A String", # How frequently automated backups should occur. The only supported value at this time is 24 hours. An undefined frequency is treated as 24 hours. + "locations": [ # Optional. A list of Cloud Bigtable zones where automated backups are allowed to be created. If empty, automated backups will be created in all zones of the instance. Locations are in the format `projects/{project}/locations/{zone}`. This field can only set for tables in Enterprise Plus instances. + "A String", + ], "retentionPeriod": "A String", # Required. How long the automated backups should be retained. Values must be at least 3 days and at most 90 days. }, "changeStreamConfig": { # Change stream configuration. # If specified, enable the change stream on this table. Otherwise, the change stream is disabled and the change stream is not retained. @@ -481,6 +495,14 @@

Method Details

}, "geographyType": { # A geography type, representing a point or region on Earth. The value is stored in `Value.bytes_value` as Well-Known Binary (WKB) bytes. # Geography }, + "int32Type": { # Int32 Values of type `Int32` are stored in `Value.int_value`. # Int32 + "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. + "bigEndianBytes": { # Encodes the value as a 4-byte big-endian two's complement value. Sorted mode: non-negative values are supported. Distinct mode: all values are supported. Compatible with: - BigQuery `BINARY` encoding - HBase `Bytes.toBytes` - Java `ByteBuffer.putInt()` with `ByteOrder.BIG_ENDIAN` # Use `BigEndianBytes` encoding. + }, + "orderedCodeBytes": { # Encodes the value in a variable length binary format of up to 5 bytes. Values that are closer to zero use fewer bytes. Sorted mode: all values are supported. Distinct mode: all values are supported. # Use `OrderedCodeBytes` encoding. + }, + }, + }, "int64Type": { # Int64 Values of type `Int64` are stored in `Value.int_value`. # Int64 "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. "bigEndianBytes": { # Encodes the value as an 8-byte big-endian two's complement value. Sorted mode: non-negative values are supported. Distinct mode: all values are supported. Compatible with: - BigQuery `BINARY` encoding - HBase `Bytes.toBytes` - Java `ByteBuffer.putLong()` with `ByteOrder.BIG_ENDIAN` # Use `BigEndianBytes` encoding. @@ -689,6 +711,9 @@

Method Details

{ # A collection of user data indexed by row, column, and timestamp. Each table is served using the resources of its parent cluster. "automatedBackupPolicy": { # Defines an automated backup policy for a table # If specified, automated backups are enabled for this table. Otherwise, automated backups are disabled. "frequency": "A String", # How frequently automated backups should occur. The only supported value at this time is 24 hours. An undefined frequency is treated as 24 hours. + "locations": [ # Optional. A list of Cloud Bigtable zones where automated backups are allowed to be created. If empty, automated backups will be created in all zones of the instance. Locations are in the format `projects/{project}/locations/{zone}`. This field can only set for tables in Enterprise Plus instances. + "A String", + ], "retentionPeriod": "A String", # Required. How long the automated backups should be retained. Values must be at least 3 days and at most 90 days. }, "changeStreamConfig": { # Change stream configuration. # If specified, enable the change stream on this table. Otherwise, the change stream is disabled and the change stream is not retained. @@ -774,6 +799,14 @@

Method Details

}, "geographyType": { # A geography type, representing a point or region on Earth. The value is stored in `Value.bytes_value` as Well-Known Binary (WKB) bytes. # Geography }, + "int32Type": { # Int32 Values of type `Int32` are stored in `Value.int_value`. # Int32 + "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. + "bigEndianBytes": { # Encodes the value as a 4-byte big-endian two's complement value. Sorted mode: non-negative values are supported. Distinct mode: all values are supported. Compatible with: - BigQuery `BINARY` encoding - HBase `Bytes.toBytes` - Java `ByteBuffer.putInt()` with `ByteOrder.BIG_ENDIAN` # Use `BigEndianBytes` encoding. + }, + "orderedCodeBytes": { # Encodes the value in a variable length binary format of up to 5 bytes. Values that are closer to zero use fewer bytes. Sorted mode: all values are supported. Distinct mode: all values are supported. # Use `OrderedCodeBytes` encoding. + }, + }, + }, "int64Type": { # Int64 Values of type `Int64` are stored in `Value.int_value`. # Int64 "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. "bigEndianBytes": { # Encodes the value as an 8-byte big-endian two's complement value. Sorted mode: non-negative values are supported. Distinct mode: all values are supported. Compatible with: - BigQuery `BINARY` encoding - HBase `Bytes.toBytes` - Java `ByteBuffer.putLong()` with `ByteOrder.BIG_ENDIAN` # Use `BigEndianBytes` encoding. @@ -974,6 +1007,9 @@

Method Details

{ # A collection of user data indexed by row, column, and timestamp. Each table is served using the resources of its parent cluster. "automatedBackupPolicy": { # Defines an automated backup policy for a table # If specified, automated backups are enabled for this table. Otherwise, automated backups are disabled. "frequency": "A String", # How frequently automated backups should occur. The only supported value at this time is 24 hours. An undefined frequency is treated as 24 hours. + "locations": [ # Optional. A list of Cloud Bigtable zones where automated backups are allowed to be created. If empty, automated backups will be created in all zones of the instance. Locations are in the format `projects/{project}/locations/{zone}`. This field can only set for tables in Enterprise Plus instances. + "A String", + ], "retentionPeriod": "A String", # Required. How long the automated backups should be retained. Values must be at least 3 days and at most 90 days. }, "changeStreamConfig": { # Change stream configuration. # If specified, enable the change stream on this table. Otherwise, the change stream is disabled and the change stream is not retained. @@ -1059,6 +1095,14 @@

Method Details

}, "geographyType": { # A geography type, representing a point or region on Earth. The value is stored in `Value.bytes_value` as Well-Known Binary (WKB) bytes. # Geography }, + "int32Type": { # Int32 Values of type `Int32` are stored in `Value.int_value`. # Int32 + "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. + "bigEndianBytes": { # Encodes the value as a 4-byte big-endian two's complement value. Sorted mode: non-negative values are supported. Distinct mode: all values are supported. Compatible with: - BigQuery `BINARY` encoding - HBase `Bytes.toBytes` - Java `ByteBuffer.putInt()` with `ByteOrder.BIG_ENDIAN` # Use `BigEndianBytes` encoding. + }, + "orderedCodeBytes": { # Encodes the value in a variable length binary format of up to 5 bytes. Values that are closer to zero use fewer bytes. Sorted mode: all values are supported. Distinct mode: all values are supported. # Use `OrderedCodeBytes` encoding. + }, + }, + }, "int64Type": { # Int64 Values of type `Int64` are stored in `Value.int_value`. # Int64 "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. "bigEndianBytes": { # Encodes the value as an 8-byte big-endian two's complement value. Sorted mode: non-negative values are supported. Distinct mode: all values are supported. Compatible with: - BigQuery `BINARY` encoding - HBase `Bytes.toBytes` - Java `ByteBuffer.putLong()` with `ByteOrder.BIG_ENDIAN` # Use `BigEndianBytes` encoding. @@ -1260,6 +1304,14 @@

Method Details

}, "geographyType": { # A geography type, representing a point or region on Earth. The value is stored in `Value.bytes_value` as Well-Known Binary (WKB) bytes. # Geography }, + "int32Type": { # Int32 Values of type `Int32` are stored in `Value.int_value`. # Int32 + "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. + "bigEndianBytes": { # Encodes the value as a 4-byte big-endian two's complement value. Sorted mode: non-negative values are supported. Distinct mode: all values are supported. Compatible with: - BigQuery `BINARY` encoding - HBase `Bytes.toBytes` - Java `ByteBuffer.putInt()` with `ByteOrder.BIG_ENDIAN` # Use `BigEndianBytes` encoding. + }, + "orderedCodeBytes": { # Encodes the value in a variable length binary format of up to 5 bytes. Values that are closer to zero use fewer bytes. Sorted mode: all values are supported. Distinct mode: all values are supported. # Use `OrderedCodeBytes` encoding. + }, + }, + }, "int64Type": { # Int64 Values of type `Int64` are stored in `Value.int_value`. # Int64 "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. "bigEndianBytes": { # Encodes the value as an 8-byte big-endian two's complement value. Sorted mode: non-negative values are supported. Distinct mode: all values are supported. Compatible with: - BigQuery `BINARY` encoding - HBase `Bytes.toBytes` - Java `ByteBuffer.putLong()` with `ByteOrder.BIG_ENDIAN` # Use `BigEndianBytes` encoding. @@ -1389,6 +1441,14 @@

Method Details

}, "geographyType": { # A geography type, representing a point or region on Earth. The value is stored in `Value.bytes_value` as Well-Known Binary (WKB) bytes. # Geography }, + "int32Type": { # Int32 Values of type `Int32` are stored in `Value.int_value`. # Int32 + "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. + "bigEndianBytes": { # Encodes the value as a 4-byte big-endian two's complement value. Sorted mode: non-negative values are supported. Distinct mode: all values are supported. Compatible with: - BigQuery `BINARY` encoding - HBase `Bytes.toBytes` - Java `ByteBuffer.putInt()` with `ByteOrder.BIG_ENDIAN` # Use `BigEndianBytes` encoding. + }, + "orderedCodeBytes": { # Encodes the value in a variable length binary format of up to 5 bytes. Values that are closer to zero use fewer bytes. Sorted mode: all values are supported. Distinct mode: all values are supported. # Use `OrderedCodeBytes` encoding. + }, + }, + }, "int64Type": { # Int64 Values of type `Int64` are stored in `Value.int_value`. # Int64 "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. "bigEndianBytes": { # Encodes the value as an 8-byte big-endian two's complement value. Sorted mode: non-negative values are supported. Distinct mode: all values are supported. Compatible with: - BigQuery `BINARY` encoding - HBase `Bytes.toBytes` - Java `ByteBuffer.putLong()` with `ByteOrder.BIG_ENDIAN` # Use `BigEndianBytes` encoding. @@ -1473,6 +1533,9 @@

Method Details

{ # A collection of user data indexed by row, column, and timestamp. Each table is served using the resources of its parent cluster. "automatedBackupPolicy": { # Defines an automated backup policy for a table # If specified, automated backups are enabled for this table. Otherwise, automated backups are disabled. "frequency": "A String", # How frequently automated backups should occur. The only supported value at this time is 24 hours. An undefined frequency is treated as 24 hours. + "locations": [ # Optional. A list of Cloud Bigtable zones where automated backups are allowed to be created. If empty, automated backups will be created in all zones of the instance. Locations are in the format `projects/{project}/locations/{zone}`. This field can only set for tables in Enterprise Plus instances. + "A String", + ], "retentionPeriod": "A String", # Required. How long the automated backups should be retained. Values must be at least 3 days and at most 90 days. }, "changeStreamConfig": { # Change stream configuration. # If specified, enable the change stream on this table. Otherwise, the change stream is disabled and the change stream is not retained. @@ -1558,6 +1621,14 @@

Method Details

}, "geographyType": { # A geography type, representing a point or region on Earth. The value is stored in `Value.bytes_value` as Well-Known Binary (WKB) bytes. # Geography }, + "int32Type": { # Int32 Values of type `Int32` are stored in `Value.int_value`. # Int32 + "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. + "bigEndianBytes": { # Encodes the value as a 4-byte big-endian two's complement value. Sorted mode: non-negative values are supported. Distinct mode: all values are supported. Compatible with: - BigQuery `BINARY` encoding - HBase `Bytes.toBytes` - Java `ByteBuffer.putInt()` with `ByteOrder.BIG_ENDIAN` # Use `BigEndianBytes` encoding. + }, + "orderedCodeBytes": { # Encodes the value in a variable length binary format of up to 5 bytes. Values that are closer to zero use fewer bytes. Sorted mode: all values are supported. Distinct mode: all values are supported. # Use `OrderedCodeBytes` encoding. + }, + }, + }, "int64Type": { # Int64 Values of type `Int64` are stored in `Value.int_value`. # Int64 "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. "bigEndianBytes": { # Encodes the value as an 8-byte big-endian two's complement value. Sorted mode: non-negative values are supported. Distinct mode: all values are supported. Compatible with: - BigQuery `BINARY` encoding - HBase `Bytes.toBytes` - Java `ByteBuffer.putLong()` with `ByteOrder.BIG_ENDIAN` # Use `BigEndianBytes` encoding. @@ -1683,6 +1754,9 @@

Method Details

{ # A collection of user data indexed by row, column, and timestamp. Each table is served using the resources of its parent cluster. "automatedBackupPolicy": { # Defines an automated backup policy for a table # If specified, automated backups are enabled for this table. Otherwise, automated backups are disabled. "frequency": "A String", # How frequently automated backups should occur. The only supported value at this time is 24 hours. An undefined frequency is treated as 24 hours. + "locations": [ # Optional. A list of Cloud Bigtable zones where automated backups are allowed to be created. If empty, automated backups will be created in all zones of the instance. Locations are in the format `projects/{project}/locations/{zone}`. This field can only set for tables in Enterprise Plus instances. + "A String", + ], "retentionPeriod": "A String", # Required. How long the automated backups should be retained. Values must be at least 3 days and at most 90 days. }, "changeStreamConfig": { # Change stream configuration. # If specified, enable the change stream on this table. Otherwise, the change stream is disabled and the change stream is not retained. @@ -1768,6 +1842,14 @@

Method Details

}, "geographyType": { # A geography type, representing a point or region on Earth. The value is stored in `Value.bytes_value` as Well-Known Binary (WKB) bytes. # Geography }, + "int32Type": { # Int32 Values of type `Int32` are stored in `Value.int_value`. # Int32 + "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. + "bigEndianBytes": { # Encodes the value as a 4-byte big-endian two's complement value. Sorted mode: non-negative values are supported. Distinct mode: all values are supported. Compatible with: - BigQuery `BINARY` encoding - HBase `Bytes.toBytes` - Java `ByteBuffer.putInt()` with `ByteOrder.BIG_ENDIAN` # Use `BigEndianBytes` encoding. + }, + "orderedCodeBytes": { # Encodes the value in a variable length binary format of up to 5 bytes. Values that are closer to zero use fewer bytes. Sorted mode: all values are supported. Distinct mode: all values are supported. # Use `OrderedCodeBytes` encoding. + }, + }, + }, "int64Type": { # Int64 Values of type `Int64` are stored in `Value.int_value`. # Int64 "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. "bigEndianBytes": { # Encodes the value as an 8-byte big-endian two's complement value. Sorted mode: non-negative values are supported. Distinct mode: all values are supported. Compatible with: - BigQuery `BINARY` encoding - HBase `Bytes.toBytes` - Java `ByteBuffer.putLong()` with `ByteOrder.BIG_ENDIAN` # Use `BigEndianBytes` encoding. diff --git a/docs/dyn/bigtableadmin_v2.projects.locations.html b/docs/dyn/bigtableadmin_v2.projects.locations.html index 0597c674b0..884a5b5e0f 100644 --- a/docs/dyn/bigtableadmin_v2.projects.locations.html +++ b/docs/dyn/bigtableadmin_v2.projects.locations.html @@ -79,7 +79,7 @@

Instance Methods

Close httplib2 connections.

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

-

Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.

+

Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.

list_next()

Retrieves the next page of results.

@@ -91,7 +91,7 @@

Method Details

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
+  
Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
diff --git a/docs/dyn/certificatemanager_v1.projects.locations.html b/docs/dyn/certificatemanager_v1.projects.locations.html
index 9db4ee8eb7..81d18af326 100644
--- a/docs/dyn/certificatemanager_v1.projects.locations.html
+++ b/docs/dyn/certificatemanager_v1.projects.locations.html
@@ -112,7 +112,7 @@ 

Instance Methods

Gets information about a location.

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

-

Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.

+

Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.

list_next()

Retrieves the next page of results.

@@ -151,7 +151,7 @@

Method Details

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
+  
Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
diff --git a/docs/dyn/ces_v1.projects.locations.apps.html b/docs/dyn/ces_v1.projects.locations.apps.html
index a81233eeb9..52f57f3b45 100644
--- a/docs/dyn/ces_v1.projects.locations.apps.html
+++ b/docs/dyn/ces_v1.projects.locations.apps.html
@@ -261,7 +261,7 @@ 

Method Details

"languageSettings": { # Language settings of the app. # Optional. Language settings of the app. "defaultLanguageCode": "A String", # Optional. The default language code of the app. "enableMultilingualSupport": True or False, # Optional. Enables multilingual support. If true, agents in the app will use pre-built instructions to improve handling of multilingual input. - "fallbackAction": "A String", # Optional. The action to perform when an agent receives input in an unsupported language. This can be a predefined action or a custom tool call. Valid values are: - A tool's full resource name, which triggers a specific tool execution. - A predefined system action, such as "escalate" or "exit", which triggers an EndSession signal with corresponding metadata to terminate the conversation. + "fallbackAction": "A String", # Optional. Deprecated: This feature is no longer supported. Use `enable_multilingual_support` instead to improve handling of multilingual input. The action to perform when an agent receives input in an unsupported language. This can be a predefined action or a custom tool call. Valid values are: - A tool's full resource name, which triggers a specific tool execution. - A predefined system action, such as "escalate" or "exit", which triggers an EndSession signal with corresponding metadata to terminate the conversation. "supportedLanguageCodes": [ # Optional. List of languages codes supported by the app, in addition to the `default_language_code`. "A String", ], @@ -653,7 +653,7 @@

Method Details

"languageSettings": { # Language settings of the app. # Optional. Language settings of the app. "defaultLanguageCode": "A String", # Optional. The default language code of the app. "enableMultilingualSupport": True or False, # Optional. Enables multilingual support. If true, agents in the app will use pre-built instructions to improve handling of multilingual input. - "fallbackAction": "A String", # Optional. The action to perform when an agent receives input in an unsupported language. This can be a predefined action or a custom tool call. Valid values are: - A tool's full resource name, which triggers a specific tool execution. - A predefined system action, such as "escalate" or "exit", which triggers an EndSession signal with corresponding metadata to terminate the conversation. + "fallbackAction": "A String", # Optional. Deprecated: This feature is no longer supported. Use `enable_multilingual_support` instead to improve handling of multilingual input. The action to perform when an agent receives input in an unsupported language. This can be a predefined action or a custom tool call. Valid values are: - A tool's full resource name, which triggers a specific tool execution. - A predefined system action, such as "escalate" or "exit", which triggers an EndSession signal with corresponding metadata to terminate the conversation. "supportedLanguageCodes": [ # Optional. List of languages codes supported by the app, in addition to the `default_language_code`. "A String", ], @@ -942,7 +942,7 @@

Method Details

"languageSettings": { # Language settings of the app. # Optional. Language settings of the app. "defaultLanguageCode": "A String", # Optional. The default language code of the app. "enableMultilingualSupport": True or False, # Optional. Enables multilingual support. If true, agents in the app will use pre-built instructions to improve handling of multilingual input. - "fallbackAction": "A String", # Optional. The action to perform when an agent receives input in an unsupported language. This can be a predefined action or a custom tool call. Valid values are: - A tool's full resource name, which triggers a specific tool execution. - A predefined system action, such as "escalate" or "exit", which triggers an EndSession signal with corresponding metadata to terminate the conversation. + "fallbackAction": "A String", # Optional. Deprecated: This feature is no longer supported. Use `enable_multilingual_support` instead to improve handling of multilingual input. The action to perform when an agent receives input in an unsupported language. This can be a predefined action or a custom tool call. Valid values are: - A tool's full resource name, which triggers a specific tool execution. - A predefined system action, such as "escalate" or "exit", which triggers an EndSession signal with corresponding metadata to terminate the conversation. "supportedLanguageCodes": [ # Optional. List of languages codes supported by the app, in addition to the `default_language_code`. "A String", ], @@ -1191,7 +1191,7 @@

Method Details

"languageSettings": { # Language settings of the app. # Optional. Language settings of the app. "defaultLanguageCode": "A String", # Optional. The default language code of the app. "enableMultilingualSupport": True or False, # Optional. Enables multilingual support. If true, agents in the app will use pre-built instructions to improve handling of multilingual input. - "fallbackAction": "A String", # Optional. The action to perform when an agent receives input in an unsupported language. This can be a predefined action or a custom tool call. Valid values are: - A tool's full resource name, which triggers a specific tool execution. - A predefined system action, such as "escalate" or "exit", which triggers an EndSession signal with corresponding metadata to terminate the conversation. + "fallbackAction": "A String", # Optional. Deprecated: This feature is no longer supported. Use `enable_multilingual_support` instead to improve handling of multilingual input. The action to perform when an agent receives input in an unsupported language. This can be a predefined action or a custom tool call. Valid values are: - A tool's full resource name, which triggers a specific tool execution. - A predefined system action, such as "escalate" or "exit", which triggers an EndSession signal with corresponding metadata to terminate the conversation. "supportedLanguageCodes": [ # Optional. List of languages codes supported by the app, in addition to the `default_language_code`. "A String", ], @@ -1419,7 +1419,7 @@

Method Details

"languageSettings": { # Language settings of the app. # Optional. Language settings of the app. "defaultLanguageCode": "A String", # Optional. The default language code of the app. "enableMultilingualSupport": True or False, # Optional. Enables multilingual support. If true, agents in the app will use pre-built instructions to improve handling of multilingual input. - "fallbackAction": "A String", # Optional. The action to perform when an agent receives input in an unsupported language. This can be a predefined action or a custom tool call. Valid values are: - A tool's full resource name, which triggers a specific tool execution. - A predefined system action, such as "escalate" or "exit", which triggers an EndSession signal with corresponding metadata to terminate the conversation. + "fallbackAction": "A String", # Optional. Deprecated: This feature is no longer supported. Use `enable_multilingual_support` instead to improve handling of multilingual input. The action to perform when an agent receives input in an unsupported language. This can be a predefined action or a custom tool call. Valid values are: - A tool's full resource name, which triggers a specific tool execution. - A predefined system action, such as "escalate" or "exit", which triggers an EndSession signal with corresponding metadata to terminate the conversation. "supportedLanguageCodes": [ # Optional. List of languages codes supported by the app, in addition to the `default_language_code`. "A String", ], diff --git a/docs/dyn/ces_v1.projects.locations.apps.versions.html b/docs/dyn/ces_v1.projects.locations.apps.versions.html index f307a8fe66..bc695d2b74 100644 --- a/docs/dyn/ces_v1.projects.locations.apps.versions.html +++ b/docs/dyn/ces_v1.projects.locations.apps.versions.html @@ -321,7 +321,7 @@

Method Details

"languageSettings": { # Language settings of the app. # Optional. Language settings of the app. "defaultLanguageCode": "A String", # Optional. The default language code of the app. "enableMultilingualSupport": True or False, # Optional. Enables multilingual support. If true, agents in the app will use pre-built instructions to improve handling of multilingual input. - "fallbackAction": "A String", # Optional. The action to perform when an agent receives input in an unsupported language. This can be a predefined action or a custom tool call. Valid values are: - A tool's full resource name, which triggers a specific tool execution. - A predefined system action, such as "escalate" or "exit", which triggers an EndSession signal with corresponding metadata to terminate the conversation. + "fallbackAction": "A String", # Optional. Deprecated: This feature is no longer supported. Use `enable_multilingual_support` instead to improve handling of multilingual input. The action to perform when an agent receives input in an unsupported language. This can be a predefined action or a custom tool call. Valid values are: - A tool's full resource name, which triggers a specific tool execution. - A predefined system action, such as "escalate" or "exit", which triggers an EndSession signal with corresponding metadata to terminate the conversation. "supportedLanguageCodes": [ # Optional. List of languages codes supported by the app, in addition to the `default_language_code`. "A String", ], @@ -1433,7 +1433,7 @@

Method Details

"languageSettings": { # Language settings of the app. # Optional. Language settings of the app. "defaultLanguageCode": "A String", # Optional. The default language code of the app. "enableMultilingualSupport": True or False, # Optional. Enables multilingual support. If true, agents in the app will use pre-built instructions to improve handling of multilingual input. - "fallbackAction": "A String", # Optional. The action to perform when an agent receives input in an unsupported language. This can be a predefined action or a custom tool call. Valid values are: - A tool's full resource name, which triggers a specific tool execution. - A predefined system action, such as "escalate" or "exit", which triggers an EndSession signal with corresponding metadata to terminate the conversation. + "fallbackAction": "A String", # Optional. Deprecated: This feature is no longer supported. Use `enable_multilingual_support` instead to improve handling of multilingual input. The action to perform when an agent receives input in an unsupported language. This can be a predefined action or a custom tool call. Valid values are: - A tool's full resource name, which triggers a specific tool execution. - A predefined system action, such as "escalate" or "exit", which triggers an EndSession signal with corresponding metadata to terminate the conversation. "supportedLanguageCodes": [ # Optional. List of languages codes supported by the app, in addition to the `default_language_code`. "A String", ], @@ -2570,7 +2570,7 @@

Method Details

"languageSettings": { # Language settings of the app. # Optional. Language settings of the app. "defaultLanguageCode": "A String", # Optional. The default language code of the app. "enableMultilingualSupport": True or False, # Optional. Enables multilingual support. If true, agents in the app will use pre-built instructions to improve handling of multilingual input. - "fallbackAction": "A String", # Optional. The action to perform when an agent receives input in an unsupported language. This can be a predefined action or a custom tool call. Valid values are: - A tool's full resource name, which triggers a specific tool execution. - A predefined system action, such as "escalate" or "exit", which triggers an EndSession signal with corresponding metadata to terminate the conversation. + "fallbackAction": "A String", # Optional. Deprecated: This feature is no longer supported. Use `enable_multilingual_support` instead to improve handling of multilingual input. The action to perform when an agent receives input in an unsupported language. This can be a predefined action or a custom tool call. Valid values are: - A tool's full resource name, which triggers a specific tool execution. - A predefined system action, such as "escalate" or "exit", which triggers an EndSession signal with corresponding metadata to terminate the conversation. "supportedLanguageCodes": [ # Optional. List of languages codes supported by the app, in addition to the `default_language_code`. "A String", ], @@ -3694,7 +3694,7 @@

Method Details

"languageSettings": { # Language settings of the app. # Optional. Language settings of the app. "defaultLanguageCode": "A String", # Optional. The default language code of the app. "enableMultilingualSupport": True or False, # Optional. Enables multilingual support. If true, agents in the app will use pre-built instructions to improve handling of multilingual input. - "fallbackAction": "A String", # Optional. The action to perform when an agent receives input in an unsupported language. This can be a predefined action or a custom tool call. Valid values are: - A tool's full resource name, which triggers a specific tool execution. - A predefined system action, such as "escalate" or "exit", which triggers an EndSession signal with corresponding metadata to terminate the conversation. + "fallbackAction": "A String", # Optional. Deprecated: This feature is no longer supported. Use `enable_multilingual_support` instead to improve handling of multilingual input. The action to perform when an agent receives input in an unsupported language. This can be a predefined action or a custom tool call. Valid values are: - A tool's full resource name, which triggers a specific tool execution. - A predefined system action, such as "escalate" or "exit", which triggers an EndSession signal with corresponding metadata to terminate the conversation. "supportedLanguageCodes": [ # Optional. List of languages codes supported by the app, in addition to the `default_language_code`. "A String", ], diff --git a/docs/dyn/ces_v1.projects.locations.html b/docs/dyn/ces_v1.projects.locations.html index 3b0196d696..7110a7c241 100644 --- a/docs/dyn/ces_v1.projects.locations.html +++ b/docs/dyn/ces_v1.projects.locations.html @@ -92,7 +92,7 @@

Instance Methods

Gets information about a location.

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

-

Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.

+

Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.

list_next()

Retrieves the next page of results.

@@ -131,7 +131,7 @@

Method Details

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
+  
Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.html b/docs/dyn/ces_v1beta.projects.locations.apps.html
index 282a172c0b..58c7ab00dc 100644
--- a/docs/dyn/ces_v1beta.projects.locations.apps.html
+++ b/docs/dyn/ces_v1beta.projects.locations.apps.html
@@ -164,6 +164,9 @@ 

Instance Methods

exportApp(name, body=None, x__xgafv=None)

Exports the specified app.

+

+ generateAppResource(parent, body=None, x__xgafv=None)

+

Generates specific resources (e.g. agent) in the app using LLM assistant.

get(name, x__xgafv=None)

Gets details of the specified app.

@@ -314,7 +317,7 @@

Method Details

"languageSettings": { # Language settings of the app. # Optional. Language settings of the app. "defaultLanguageCode": "A String", # Optional. The default language code of the app. "enableMultilingualSupport": True or False, # Optional. Enables multilingual support. If true, agents in the app will use pre-built instructions to improve handling of multilingual input. - "fallbackAction": "A String", # Optional. The action to perform when an agent receives input in an unsupported language. This can be a predefined action or a custom tool call. Valid values are: - A tool's full resource name, which triggers a specific tool execution. - A predefined system action, such as "escalate" or "exit", which triggers an EndSession signal with corresponding metadata to terminate the conversation. + "fallbackAction": "A String", # Optional. Deprecated: This feature is no longer supported. Use `enable_multilingual_support` instead to improve handling of multilingual input. The action to perform when an agent receives input in an unsupported language. This can be a predefined action or a custom tool call. Valid values are: - A tool's full resource name, which triggers a specific tool execution. - A predefined system action, such as "escalate" or "exit", which triggers an EndSession signal with corresponding metadata to terminate the conversation. "supportedLanguageCodes": [ # Optional. List of languages codes supported by the app, in addition to the `default_language_code`. "A String", ], @@ -603,6 +606,824 @@

Method Details

}
+
+ generateAppResource(parent, body=None, x__xgafv=None) +
Generates specific resources (e.g. agent) in the app using LLM assistant.
+
+Args:
+  parent: string, Required. The resource name of the app to generate the resource for. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for AgentService.GenerateAppResource.
+  "agent": { # An agent acts as the fundamental building block that provides instructions to the Large Language Model (LLM) for executing specific tasks. # The agent resource to be used by the LLM assistant, can be empty for generating a new agent.
+    "afterAgentCallbacks": [ # Optional. The callbacks to execute after the agent is called. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped.
+      { # A callback defines the custom logic to be executed at various stages of agent interaction.
+        "description": "A String", # Optional. Human-readable description of the callback.
+        "disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+        "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
+        "pythonCode": "A String", # Required. The python code to execute for the callback.
+      },
+    ],
+    "afterModelCallbacks": [ # Optional. The callbacks to execute after the model is called. If there are multiple calls to the model, the callback will be executed multiple times. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped.
+      { # A callback defines the custom logic to be executed at various stages of agent interaction.
+        "description": "A String", # Optional. Human-readable description of the callback.
+        "disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+        "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
+        "pythonCode": "A String", # Required. The python code to execute for the callback.
+      },
+    ],
+    "afterToolCallbacks": [ # Optional. The callbacks to execute after the tool is invoked. If there are multiple tool invocations, the callback will be executed multiple times. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped.
+      { # A callback defines the custom logic to be executed at various stages of agent interaction.
+        "description": "A String", # Optional. Human-readable description of the callback.
+        "disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+        "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
+        "pythonCode": "A String", # Required. The python code to execute for the callback.
+      },
+    ],
+    "beforeAgentCallbacks": [ # Optional. The callbacks to execute before the agent is called. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped.
+      { # A callback defines the custom logic to be executed at various stages of agent interaction.
+        "description": "A String", # Optional. Human-readable description of the callback.
+        "disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+        "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
+        "pythonCode": "A String", # Required. The python code to execute for the callback.
+      },
+    ],
+    "beforeModelCallbacks": [ # Optional. The callbacks to execute before the model is called. If there are multiple calls to the model, the callback will be executed multiple times. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped.
+      { # A callback defines the custom logic to be executed at various stages of agent interaction.
+        "description": "A String", # Optional. Human-readable description of the callback.
+        "disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+        "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
+        "pythonCode": "A String", # Required. The python code to execute for the callback.
+      },
+    ],
+    "beforeToolCallbacks": [ # Optional. The callbacks to execute before the tool is invoked. If there are multiple tool invocations, the callback will be executed multiple times. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped.
+      { # A callback defines the custom logic to be executed at various stages of agent interaction.
+        "description": "A String", # Optional. Human-readable description of the callback.
+        "disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+        "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
+        "pythonCode": "A String", # Required. The python code to execute for the callback.
+      },
+    ],
+    "childAgents": [ # Optional. List of child agents in the agent tree. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`
+      "A String",
+    ],
+    "createTime": "A String", # Output only. Timestamp when the agent was created.
+    "description": "A String", # Optional. Human-readable description of the agent.
+    "displayName": "A String", # Required. Display name of the agent.
+    "etag": "A String", # Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
+    "generatedSummary": "A String", # Output only. If the agent is generated by the LLM assistant, this field contains a descriptive summary of the generation.
+    "guardrails": [ # Optional. List of guardrails for the agent. Format: `projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}`
+      "A String",
+    ],
+    "instruction": "A String", # Optional. Instructions for the LLM model to guide the agent's behavior.
+    "llmAgent": { # Default agent type. The agent uses instructions and callbacks specified in the agent to perform the task using a large language model. # Optional. The default agent type.
+    },
+    "modelSettings": { # Model settings contains various configurations for the LLM model. # Optional. Configurations for the LLM model.
+      "model": "A String", # Optional. The LLM model that the agent should use. If not set, the agent will inherit the model from its parent agent.
+      "temperature": 3.14, # Optional. If set, this temperature will be used for the LLM model. Temperature controls the randomness of the model's responses. Lower temperatures produce responses that are more predictable. Higher temperatures produce responses that are more creative.
+    },
+    "name": "A String", # Identifier. The unique identifier of the agent. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`
+    "remoteDialogflowAgent": { # The agent which will transfer execution to a remote [Dialogflow CX](https://docs.cloud.google.com/dialogflow/cx/docs/concept/agent) agent. The Dialogflow agent will process subsequent user queries until the session ends or flow ends, and the control is transferred back to the parent CES agent. # Optional. The remote [Dialogflow](https://cloud.google.com/dialogflow/cx/docs/concept/console-conversational-agents) agent to be used for the agent execution. If this field is set, all other agent level properties will be ignored. Note: If the Dialogflow agent is in a different project from the app, you should grant `roles/dialogflow.client` to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+      "agent": "A String", # Required. The [Dialogflow](https://docs.cloud.google.com/dialogflow/cx/docs/concept/agent) agent resource name. Format: `projects/{project}/locations/{location}/agents/{agent}`
+      "environmentId": "A String", # Optional. The environment ID of the Dialogflow agent to be used for the agent execution. If not specified, the draft environment will be used.
+      "flowId": "A String", # Optional. The flow ID of the flow in the Dialogflow agent.
+      "inputVariableMapping": { # Optional. The mapping of the app variables names to the Dialogflow session parameters names to be sent to the Dialogflow agent as input.
+        "a_key": "A String",
+      },
+      "outputVariableMapping": { # Optional. The mapping of the Dialogflow session parameters names to the app variables names to be sent back to the CES agent after the Dialogflow agent execution ends.
+        "a_key": "A String",
+      },
+      "respectResponseInterruptionSettings": True or False, # Optional. Indicates whether to respect the message-level interruption settings configured in the Dialogflow agent. * If false: all response messages from the Dialogflow agent follow the app-level barge-in settings. * If true: only response messages with [`allow_playback_interruption`](https://docs.cloud.google.com/dialogflow/cx/docs/reference/rpc/google.cloud.dialogflow.cx.v3#text) set to true will be interruptable, all other messages follow the app-level barge-in settings.
+    },
+    "tools": [ # Optional. List of available tools for the agent. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`
+      "A String",
+    ],
+    "toolsets": [ # Optional. List of toolsets for the agent.
+      { # A toolset with a selection of its tools.
+        "toolIds": [ # Optional. The tools IDs to filter the toolset.
+          "A String",
+        ],
+        "toolset": "A String", # Required. The resource name of the toolset. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`
+      },
+    ],
+    "transferRules": [ # Optional. Agent transfer rules. If multiple rules match, the first one in the list will be used.
+      { # Rule for transferring to a specific agent.
+        "childAgent": "A String", # Required. The resource name of the child agent the rule applies to. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`
+        "deterministicTransfer": { # Deterministic transfer rule. When the condition evaluates to true, the transfer occurs. # Optional. A rule that immediately transfers to the target agent when the condition is met.
+          "expressionCondition": { # Expression condition based on session state. # Optional. A rule that evaluates a session state condition. If the condition evaluates to true, the transfer occurs.
+            "expression": "A String", # Required. The string representation of cloud.api.Expression condition.
+          },
+          "pythonCodeCondition": { # Python code block to evaluate the condition. # Optional. A rule that uses Python code block to evaluate the conditions. If the condition evaluates to true, the transfer occurs.
+            "pythonCode": "A String", # Required. The python code to execute.
+          },
+        },
+        "direction": "A String", # Required. The direction of the transfer.
+        "disablePlannerTransfer": { # A rule that prevents the planner from transferring to the target agent. # Optional. Rule that prevents the planner from transferring to the target agent.
+          "expressionCondition": { # Expression condition based on session state. # Required. If the condition evaluates to true, planner will not be allowed to transfer to the target agent.
+            "expression": "A String", # Required. The string representation of cloud.api.Expression condition.
+          },
+        },
+      },
+    ],
+    "updateTime": "A String", # Output only. Timestamp when the agent was last updated.
+  },
+  "appGenerationConfig": { # The configuration to be used to generate the app. # Optional. The configuration to be used to generate the agents and tools.
+    "context": "A String", # Optional. The context which describes the requirements of the agents & tools to be generated.
+    "datasetId": "A String", # Optional. The insights dataset to be used to fetch conversation data for generating the agents & tools. Format: `projects/{project}/locations/{location}/datasets/{dataset}`.
+    "fileContexts": [ # Optional. The files to be used as context.
+      { # Files to be used as context. Files can be provided as raw bytes.
+        "fileBytes": { # File provided as raw bytes. # Optional. File provided as raw bytes.
+          "data": "A String", # Required. Raw bytes of the file.
+          "fileName": "A String", # Required. The name of the file provided as raw bytes.
+          "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+        },
+      },
+    ],
+    "gcsLocation": "A String", # Optional. The Cloud Storage location to store the generated question answer data to be used by the Datastore tool. This data is generated only when using conversation data as an input source. The location must be in the same project as the app. Format: `gs://...`.
+    "generateEvaluations": True or False, # Optional. Whether to generate the evaluations for the app. If true, the provided context will be used to generate the evaluations data.
+  },
+  "evaluationGenerationConfig": { # The configuration to be used to generate the evaluations. # Optional. The configuration to be used to generate the evaluations.
+    "datasetId": "A String", # Optional. The insights dataset to be used to fetch conversation data for generating the evaluations. Format: `projects/{project}/locations/{location}/datasets/{dataset}`.
+  },
+  "evaluationPersonasGenerationConfig": { # The configuration to be used to generate the evaluation personas. # Optional. The configuration to be used to generate the evaluation personas.
+  },
+  "hillClimbingFixConfig": { # The configuration to be used for hill climbing fixes. # Optional. The configuration to be used for hill climbing fixes.
+    "qualityReport": { # The report describing any identified quality issues in the app. # Required. The quality report used to inform the instruction following fix.
+      "evaluationRuns": [ # Optional. A list of evaluation runs used to generate the quality report. Format: `projects/{project}/locations/{location}/evaluationRuns/{evaluationRun}`.
+        "A String",
+      ],
+      "generalIssues": [ # Optional. General issues not specific to any agent.
+        { # The issue identified.
+          "description": "A String", # Optional. Description of the issue found.
+          "occurrenceCount": 42, # Optional. How many times this issue occurred.
+          "proposedSolution": "A String", # Optional. Proposed solution to fix the issue by modifying instructions or tools.
+        },
+      ],
+      "issues": [ # Optional. The issues grouped by agent.
+        { # Issues identified for a single agent.
+          "agent": "A String", # Optional. The name of the agent to which the issues are related. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`
+          "issues": [ # Optional. List of issues found for this agent.
+            { # The issue identified.
+              "description": "A String", # Optional. Description of the issue found.
+              "occurrenceCount": 42, # Optional. How many times this issue occurred.
+              "proposedSolution": "A String", # Optional. Proposed solution to fix the issue by modifying instructions or tools.
+            },
+          ],
+        },
+      ],
+    },
+  },
+  "qualityReportGenerationConfig": { # The configuration to be used for quality report generation. # Optional. The configuration to be used for quality report generation.
+    "evaluationRun": "A String", # Required. The evaluation run used to inform quality report analysis.
+  },
+  "refineInstructions": [ # Optional. List of refine instructions to be used to refine the resource.
+    { # The instructions to be used to refine a part of the resource. The part of the resource can be specified with a start index, end index and a field mask. For example, if you want to refine a part of the agent instructions you can specify the index of the first character of the instructions, the index of the last character of the instructions and the field mask as "instructions".
+      "endIndex": "A String", # Required. The last character (inclusive) of the text to refine.
+      "fieldMask": "A String", # Required. The field of the resource being refined. Only one field is allowed per RefineInstructions. If refining agent instructions, the field mask should be "instructions".
+      "instructions": "A String", # Required. The instructions to refine the resource.
+      "startIndex": "A String", # Required. The first character (inclusive) of the text to refine.
+    },
+  ],
+  "tool": { # A tool represents an action that the CES agent can take to achieve certain goals. # The tool resource to be used by the LLM assistant, can be empty for generating a new tool.
+    "agentTool": { # Represents a tool that allows the agent to call another agent. # Optional. The agent tool.
+      "description": "A String", # Optional. Description of the tool's purpose.
+      "name": "A String", # Required. The name of the agent tool.
+      "rootAgent": "A String", # Optional. The resource name of the root agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}`
+    },
+    "clientFunction": { # Represents a client-side function that the agent can invoke. When the tool is chosen by the agent, control is handed off to the client. The client is responsible for executing the function and returning the result as a ToolResponse to continue the interaction with the agent. # Optional. The client function.
+      "description": "A String", # Optional. The function description.
+      "name": "A String", # Required. The function name.
+      "parameters": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the function parameters.
+        "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties.
+        "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
+          # Object with schema name: Schema
+        ],
+        "default": "", # Optional. Default value of the data.
+        "defs": { # Optional. A map of definitions for use by `ref`. Only allowed at the root of the schema.
+          "a_key": # Object with schema name: Schema
+        },
+        "description": "A String", # Optional. The description of the data.
+        "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
+          "A String",
+        ],
+        "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY.
+        "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
+        "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER.
+        "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
+        "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER.
+        "nullable": True or False, # Optional. Indicates if the value may be null.
+        "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY.
+          # Object with schema name: Schema
+        ],
+        "properties": { # Optional. Properties of Type.OBJECT.
+          "a_key": # Object with schema name: Schema
+        },
+        "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+        "required": [ # Optional. Required properties of Type.OBJECT.
+          "A String",
+        ],
+        "title": "A String", # Optional. The title of the schema.
+        "type": "A String", # Required. The type of the data.
+        "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
+      },
+      "response": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the function response.
+        "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties.
+        "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
+          # Object with schema name: Schema
+        ],
+        "default": "", # Optional. Default value of the data.
+        "defs": { # Optional. A map of definitions for use by `ref`. Only allowed at the root of the schema.
+          "a_key": # Object with schema name: Schema
+        },
+        "description": "A String", # Optional. The description of the data.
+        "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
+          "A String",
+        ],
+        "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY.
+        "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
+        "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER.
+        "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
+        "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER.
+        "nullable": True or False, # Optional. Indicates if the value may be null.
+        "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY.
+          # Object with schema name: Schema
+        ],
+        "properties": { # Optional. Properties of Type.OBJECT.
+          "a_key": # Object with schema name: Schema
+        },
+        "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+        "required": [ # Optional. Required properties of Type.OBJECT.
+          "A String",
+        ],
+        "title": "A String", # Optional. The title of the schema.
+        "type": "A String", # Required. The type of the data.
+        "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
+      },
+    },
+    "connectorTool": { # A ConnectorTool allows connections to different integrations. See: https://cloud.google.com/integration-connectors/docs/overview. # Optional. The Integration Connector tool.
+      "action": { # Configuration of an Action for the tool to use. Note: This can be either an Action or an Operation. See https://cloud.google.com/integration-connectors/docs/entities-operation-action for details. # Required. Action for the tool to use.
+        "connectionActionId": "A String", # ID of a Connection action for the tool to use.
+        "entityOperation": { # Entity CRUD operation specification. # Entity operation configuration for the tool to use.
+          "entityId": "A String", # Required. ID of the entity.
+          "operation": "A String", # Required. Operation to perform on the entity.
+        },
+        "inputFields": [ # Optional. Entity fields to use as inputs for the operation. If no fields are specified, all fields of the Entity will be used.
+          "A String",
+        ],
+        "outputFields": [ # Optional. Entity fields to return from the operation. If no fields are specified, all fields of the Entity will be returned.
+          "A String",
+        ],
+      },
+      "authConfig": { # End-user authentication configuration used for Connection calls. The field values must be the names of context variables in the format `$context.variables.`. # Optional. Configures how authentication is handled in Integration Connectors. By default, an admin authentication is passed in the Integration Connectors API requests. You can override it with a different end-user authentication config. **Note**: The Connection must have authentication override enabled in order to specify an EUC configuration here - otherwise, the ConnectorTool creation will fail. See https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override for details.
+        "oauth2AuthCodeConfig": { # Oauth 2.0 Authorization Code authentication configuration. # Oauth 2.0 Authorization Code authentication.
+          "oauthToken": "A String", # Required. Oauth token parameter name to pass through. Must be in the format `$context.variables.`.
+        },
+        "oauth2JwtBearerConfig": { # JWT Profile Oauth 2.0 Authorization Grant authentication configuration. # JWT Profile Oauth 2.0 Authorization Grant authentication.
+          "clientKey": "A String", # Required. Client parameter name to pass through. Must be in the format `$context.variables.`.
+          "issuer": "A String", # Required. Issuer parameter name to pass through. Must be in the format `$context.variables.`.
+          "subject": "A String", # Required. Subject parameter name to pass through. Must be in the format `$context.variables.`.
+        },
+      },
+      "connection": "A String", # Required. The full resource name of the referenced Integration Connectors Connection. Format: `projects/{project}/locations/{location}/connections/{connection}`
+      "description": "A String", # Optional. The description of the tool that can be used by the Agent to decide whether to call this ConnectorTool.
+      "name": "A String", # Optional. The name of the tool that can be used by the Agent to decide whether to call this ConnectorTool.
+    },
+    "createTime": "A String", # Output only. Timestamp when the tool was created.
+    "dataStoreTool": { # Tool to retrieve from Vertex AI Search datastore or engine for grounding. Accepts either a datastore or an engine, but not both. See Vertex AI Search: https://cloud.google.com/generative-ai-app-builder/docs/enterprise-search-introduction. # Optional. The data store tool.
+      "boostSpecs": [ # Optional. Boost specification to boost certain documents.
+        { # Boost specifications to boost certain documents. For more information, please refer to https://cloud.google.com/generative-ai-app-builder/docs/boosting.
+          "dataStores": [ # Required. The Data Store where the boosting configuration is applied. Full resource name of DataStore, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}.
+            "A String",
+          ],
+          "spec": [ # Required. A list of boosting specifications.
+            { # Boost specification to boost certain documents.
+              "conditionBoostSpecs": [ # Required. A list of boosting specifications.
+                { # Boost specification for a condition.
+                  "boost": 3.14, # Optional. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the suggestions a big promotion. However, it does not necessarily mean that the top result will be a boosted suggestion. Setting to -1.0 gives the suggestions a big demotion. However, other suggestions that are relevant might still be shown. Setting to 0.0 means no boost applied. The boosting condition is ignored.
+                  "boostControlSpec": { # Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above. # Optional. Complex specification for custom ranking based on customer defined attribute value.
+                    "attributeType": "A String", # Optional. The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value).
+                    "controlPoints": [ # Optional. The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.
+                      { # The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).
+                        "attributeValue": "A String", # Optional. Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`.
+                        "boostAmount": 3.14, # Optional. The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.
+                      },
+                    ],
+                    "fieldName": "A String", # Optional. The name of the field whose value will be used to determine the boost amount.
+                    "interpolationType": "A String", # Optional. The interpolation type to be applied to connect the control points listed below.
+                  },
+                  "condition": "A String", # Required. An expression which specifies a boost condition. The syntax is the same as filter expression syntax. Currently, the only supported condition is a list of BCP-47 lang codes. Example: To boost suggestions in languages en or fr: (lang_code: ANY("en", "fr"))
+                },
+              ],
+            },
+          ],
+        },
+      ],
+      "dataStoreSource": { # Configuration for searching within a specific DataStore. # Optional. Search within a single specific DataStore.
+        "dataStore": { # A DataStore resource in Vertex AI Search. # Optional. The data store.
+          "connectorConfig": { # The connector config for the data store connection. # Output only. The connector config for the data store connection.
+            "collection": "A String", # Resource name of the collection the data store belongs to.
+            "collectionDisplayName": "A String", # Display name of the collection the data store belongs to.
+            "dataSource": "A String", # The name of the data source. Example: `salesforce`, `jira`, `confluence`, `bigquery`.
+          },
+          "createTime": "A String", # Output only. Timestamp when the data store was created.
+          "displayName": "A String", # Output only. The display name of the data store.
+          "documentProcessingMode": "A String", # Output only. The document processing mode for the data store connection. Only set for PUBLIC_WEB and UNSTRUCTURED data stores.
+          "name": "A String", # Required. Full resource name of the DataStore. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
+          "type": "A String", # Output only. The type of the data store. This field is readonly and populated by the server.
+        },
+        "filter": "A String", # Optional. Filter specification for the DataStore. See: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata
+      },
+      "description": "A String", # Optional. The tool description.
+      "engineSource": { # Configuration for searching within an Engine, potentially targeting specific DataStores. # Optional. Search within an Engine (potentially across multiple DataStores).
+        "dataStoreSources": [ # Optional. Use to target specific DataStores within the Engine. If empty, the search applies to all DataStores associated with the Engine.
+          { # Configuration for searching within a specific DataStore.
+            "dataStore": { # A DataStore resource in Vertex AI Search. # Optional. The data store.
+              "connectorConfig": { # The connector config for the data store connection. # Output only. The connector config for the data store connection.
+                "collection": "A String", # Resource name of the collection the data store belongs to.
+                "collectionDisplayName": "A String", # Display name of the collection the data store belongs to.
+                "dataSource": "A String", # The name of the data source. Example: `salesforce`, `jira`, `confluence`, `bigquery`.
+              },
+              "createTime": "A String", # Output only. Timestamp when the data store was created.
+              "displayName": "A String", # Output only. The display name of the data store.
+              "documentProcessingMode": "A String", # Output only. The document processing mode for the data store connection. Only set for PUBLIC_WEB and UNSTRUCTURED data stores.
+              "name": "A String", # Required. Full resource name of the DataStore. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
+              "type": "A String", # Output only. The type of the data store. This field is readonly and populated by the server.
+            },
+            "filter": "A String", # Optional. Filter specification for the DataStore. See: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata
+          },
+        ],
+        "engine": "A String", # Required. Full resource name of the Engine. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`
+        "filter": "A String", # Optional. A filter applied to the search across the Engine. Not relevant and not used if 'data_store_sources' is provided. See: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata
+      },
+      "filterParameterBehavior": "A String", # Optional. The filter parameter behavior.
+      "modalityConfigs": [ # Optional. The modality configs for the data store.
+        { # If specified, will apply the given configuration for the specified modality.
+          "groundingConfig": { # Grounding configuration. # Optional. The grounding configuration.
+            "disabled": True or False, # Optional. Whether grounding is disabled.
+            "groundingLevel": 3.14, # Optional. The groundedness threshold of the answer based on the retrieved sources. The value has a configurable range of [1, 5]. The level is used to threshold the groundedness of the answer, meaning that all responses with a groundedness score below the threshold will fall back to returning relevant snippets only. For example, a level of 3 means that the groundedness score must be 3 or higher for the response to be returned.
+          },
+          "modalityType": "A String", # Required. The modality type.
+          "rewriterConfig": { # Rewriter configuration. # Optional. The rewriter config.
+            "disabled": True or False, # Optional. Whether the rewriter is disabled.
+            "modelSettings": { # Model settings contains various configurations for the LLM model. # Required. Configurations for the LLM model.
+              "model": "A String", # Optional. The LLM model that the agent should use. If not set, the agent will inherit the model from its parent agent.
+              "temperature": 3.14, # Optional. If set, this temperature will be used for the LLM model. Temperature controls the randomness of the model's responses. Lower temperatures produce responses that are more predictable. Higher temperatures produce responses that are more creative.
+            },
+            "prompt": "A String", # Optional. The prompt definition. If not set, default prompt will be used.
+          },
+          "summarizationConfig": { # Summarization configuration. # Optional. The summarization config.
+            "disabled": True or False, # Optional. Whether summarization is disabled.
+            "modelSettings": { # Model settings contains various configurations for the LLM model. # Optional. Configurations for the LLM model.
+              "model": "A String", # Optional. The LLM model that the agent should use. If not set, the agent will inherit the model from its parent agent.
+              "temperature": 3.14, # Optional. If set, this temperature will be used for the LLM model. Temperature controls the randomness of the model's responses. Lower temperatures produce responses that are more predictable. Higher temperatures produce responses that are more creative.
+            },
+            "prompt": "A String", # Optional. The prompt definition. If not set, default prompt will be used.
+          },
+        },
+      ],
+      "name": "A String", # Required. The data store tool name.
+    },
+    "displayName": "A String", # Output only. The display name of the tool, derived based on the tool's type. For example, display name of a ClientFunction is derived from its `name` property.
+    "etag": "A String", # Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
+    "executionType": "A String", # Optional. The execution type of the tool.
+    "fileSearchTool": { # The file search tool allows the agent to search across the files uploaded by the app/agent developer. It has presets to give relatively good quality search over the uploaded files and summarization of the retrieved results. # Optional. The file search tool.
+      "corpusType": "A String", # Optional. The type of the corpus. Default is FULLY_MANAGED.
+      "description": "A String", # Optional. The tool description.
+      "fileCorpus": "A String", # Optional. The corpus where files are stored. Format: projects/{project}/locations/{location}/ragCorpora/{rag_corpus}
+      "name": "A String", # Required. The tool name.
+    },
+    "generatedSummary": "A String", # Output only. If the tool is generated by the LLM assistant, this field contains a descriptive summary of the generation.
+    "googleSearchTool": { # Represents a tool to perform Google web searches for grounding. See https://cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool#google-search. # Optional. The google search tool.
+      "contextUrls": [ # Optional. Content will be fetched directly from these URLs for context and grounding. Example: "https://example.com/path.html". A maximum of 20 URLs are allowed.
+        "A String",
+      ],
+      "description": "A String", # Optional. Description of the tool's purpose.
+      "excludeDomains": [ # Optional. List of domains to be excluded from the search results. Example: "example.com". A maximum of 2000 domains can be excluded.
+        "A String",
+      ],
+      "name": "A String", # Required. The name of the tool.
+      "preferredDomains": [ # Optional. Specifies domains to restrict search results to. Example: "example.com", "another.site". A maximum of 20 domains can be specified.
+        "A String",
+      ],
+      "promptConfig": { # Prompt settings used by the model when processing or summarizing the google search results. # Optional. Prompt instructions passed to planner on how the search results should be processed for text and voice.
+        "textPrompt": "A String", # Optional. Defines the prompt used for the system instructions when interacting with the agent in chat conversations. If not set, default prompt will be used.
+        "voicePrompt": "A String", # Optional. Defines the prompt used for the system instructions when interacting with the agent in voice conversations. If not set, default prompt will be used.
+      },
+    },
+    "mcpTool": { # An MCP tool. See https://modelcontextprotocol.io/specification/2025-06-18/server/tools for more details. # Optional. The MCP tool. An MCP tool cannot be created or updated directly and is managed by the MCP toolset.
+      "apiAuthentication": { # Authentication information required for API calls. # Optional. Authentication information required to execute the tool against the MCP server. For bearer token authentication, the token applies only to tool execution, not to listing tools. This requires that tools can be listed without authentication.
+        "apiKeyConfig": { # Configurations for authentication with API key. # Optional. Config for API key auth.
+          "apiKeySecretVersion": "A String", # Required. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+          "keyName": "A String", # Required. The parameter name or the header name of the API key. E.g., If the API request is "https://example.com/act?X-Api-Key=", "X-Api-Key" would be the parameter name.
+          "requestLocation": "A String", # Required. Key location in the request.
+        },
+        "bearerTokenConfig": { # Configurations for authentication with a bearer token. # Optional. Config for bearer token auth.
+          "token": "A String", # Required. The bearer token. Must be in the format `$context.variables.`.
+        },
+        "oauthConfig": { # Configurations for authentication with OAuth. # Optional. Config for OAuth.
+          "clientId": "A String", # Required. The client ID from the OAuth provider.
+          "clientSecretVersion": "A String", # Required. The name of the SecretManager secret version resource storing the client secret. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+          "oauthGrantType": "A String", # Required. OAuth grant types.
+          "scopes": [ # Optional. The OAuth scopes to grant.
+            "A String",
+          ],
+          "tokenEndpoint": "A String", # Required. The token endpoint in the OAuth provider to exchange for an access token.
+        },
+        "serviceAccountAuthConfig": { # Configurations for authentication using a custom service account. # Optional. Config for service account authentication.
+          "scopes": [ # Optional. The OAuth scopes to grant. If not specified, the default scope `https://www.googleapis.com/auth/cloud-platform` is used.
+            "A String",
+          ],
+          "serviceAccount": "A String", # Required. The email address of the service account used for authentication. CES uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+        },
+        "serviceAgentIdTokenAuthConfig": { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent.
+        },
+      },
+      "customHeaders": { # Optional. The custom headers to send in the request to the MCP server. The values must be in the format `$context.variables.` and can be set in the session variables. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection for more details.
+        "a_key": "A String",
+      },
+      "description": "A String", # Optional. The description of the MCP tool.
+      "inputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the input arguments of the MCP tool.
+        "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties.
+        "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
+          # Object with schema name: Schema
+        ],
+        "default": "", # Optional. Default value of the data.
+        "defs": { # Optional. A map of definitions for use by `ref`. Only allowed at the root of the schema.
+          "a_key": # Object with schema name: Schema
+        },
+        "description": "A String", # Optional. The description of the data.
+        "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
+          "A String",
+        ],
+        "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY.
+        "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
+        "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER.
+        "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
+        "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER.
+        "nullable": True or False, # Optional. Indicates if the value may be null.
+        "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY.
+          # Object with schema name: Schema
+        ],
+        "properties": { # Optional. Properties of Type.OBJECT.
+          "a_key": # Object with schema name: Schema
+        },
+        "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+        "required": [ # Optional. Required properties of Type.OBJECT.
+          "A String",
+        ],
+        "title": "A String", # Optional. The title of the schema.
+        "type": "A String", # Required. The type of the data.
+        "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
+      },
+      "name": "A String", # Required. The name of the MCP tool.
+      "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the output arguments of the MCP tool.
+        "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties.
+        "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
+          # Object with schema name: Schema
+        ],
+        "default": "", # Optional. Default value of the data.
+        "defs": { # Optional. A map of definitions for use by `ref`. Only allowed at the root of the schema.
+          "a_key": # Object with schema name: Schema
+        },
+        "description": "A String", # Optional. The description of the data.
+        "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
+          "A String",
+        ],
+        "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY.
+        "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
+        "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER.
+        "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
+        "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER.
+        "nullable": True or False, # Optional. Indicates if the value may be null.
+        "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY.
+          # Object with schema name: Schema
+        ],
+        "properties": { # Optional. Properties of Type.OBJECT.
+          "a_key": # Object with schema name: Schema
+        },
+        "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+        "required": [ # Optional. Required properties of Type.OBJECT.
+          "A String",
+        ],
+        "title": "A String", # Optional. The title of the schema.
+        "type": "A String", # Required. The type of the data.
+        "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
+      },
+      "serverAddress": "A String", # Required. The server address of the MCP server, e.g., "https://example.com/mcp/". If the server is built with the MCP SDK, the url should be suffixed with "/mcp/". Only Streamable HTTP transport based servers are supported. This is the same as the server_address in the McpToolset. See https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http for more details.
+      "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter.
+        "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app.
+      },
+      "tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust.
+        "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification.
+          { # The CA certificate.
+            "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ```
+            "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates.
+          },
+        ],
+      },
+    },
+    "name": "A String", # Identifier. The resource name of the tool. Format: * `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` for standalone tools. * `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool}` for tools retrieved from a toolset. These tools are dynamic and output-only; they cannot be referenced directly where a tool is expected.
+    "openApiTool": { # A remote API tool defined by an OpenAPI schema. # Optional. The open API tool.
+      "apiAuthentication": { # Authentication information required for API calls. # Optional. Authentication information required by the API.
+        "apiKeyConfig": { # Configurations for authentication with API key. # Optional. Config for API key auth.
+          "apiKeySecretVersion": "A String", # Required. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+          "keyName": "A String", # Required. The parameter name or the header name of the API key. E.g., If the API request is "https://example.com/act?X-Api-Key=", "X-Api-Key" would be the parameter name.
+          "requestLocation": "A String", # Required. Key location in the request.
+        },
+        "bearerTokenConfig": { # Configurations for authentication with a bearer token. # Optional. Config for bearer token auth.
+          "token": "A String", # Required. The bearer token. Must be in the format `$context.variables.`.
+        },
+        "oauthConfig": { # Configurations for authentication with OAuth. # Optional. Config for OAuth.
+          "clientId": "A String", # Required. The client ID from the OAuth provider.
+          "clientSecretVersion": "A String", # Required. The name of the SecretManager secret version resource storing the client secret. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+          "oauthGrantType": "A String", # Required. OAuth grant types.
+          "scopes": [ # Optional. The OAuth scopes to grant.
+            "A String",
+          ],
+          "tokenEndpoint": "A String", # Required. The token endpoint in the OAuth provider to exchange for an access token.
+        },
+        "serviceAccountAuthConfig": { # Configurations for authentication using a custom service account. # Optional. Config for service account authentication.
+          "scopes": [ # Optional. The OAuth scopes to grant. If not specified, the default scope `https://www.googleapis.com/auth/cloud-platform` is used.
+            "A String",
+          ],
+          "serviceAccount": "A String", # Required. The email address of the service account used for authentication. CES uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+        },
+        "serviceAgentIdTokenAuthConfig": { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent.
+        },
+      },
+      "description": "A String", # Optional. The description of the tool. If not provided, the description of the tool will be derived from the OpenAPI schema, from `operation.description` or `operation.summary`.
+      "ignoreUnknownFields": True or False, # Optional. If true, the agent will ignore unknown fields in the API response.
+      "name": "A String", # Optional. The name of the tool. If not provided, the name of the tool will be derived from the OpenAPI schema, from `operation.operationId`.
+      "openApiSchema": "A String", # Required. The OpenAPI schema in JSON or YAML format.
+      "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration.
+        "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app.
+      },
+      "tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client will trust.
+        "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification.
+          { # The CA certificate.
+            "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ```
+            "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates.
+          },
+        ],
+      },
+      "url": "A String", # Optional. The server URL of the Open API schema. This field is only set in tools in the environment dependencies during the export process if the schema contains a server url. During the import process, if this url is present in the environment dependencies and the schema has the $env_var placeholder, it will replace the placeholder in the schema.
+    },
+    "pythonFunction": { # A Python function tool. # Optional. The python function tool.
+      "description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring.
+      "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used.
+      "pythonCode": "A String", # Optional. The Python code to execute for the tool.
+    },
+    "systemTool": { # Pre-defined system tool. # Optional. The system tool.
+      "description": "A String", # Output only. The description of the system tool.
+      "name": "A String", # Required. The name of the system tool.
+    },
+    "toolFakeConfig": { # Configuration for tool behavior in fake mode. # Optional. Configuration for tool behavior in fake mode.
+      "codeBlock": { # A code block to be executed instead of a real tool call. # Optional. Code block which will be executed instead of a real tool call.
+        "pythonCode": "A String", # Required. Python code which will be invoked in tool fake mode. Expected Python function signature - To catch all tool calls: def fake_tool_call(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: To catch a specific tool call: def fake_{tool_id}(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: If the function returns None, the real tool will be invoked instead.
+      },
+      "enableFakeMode": True or False, # Optional. Whether the tool is using fake mode.
+    },
+    "updateTime": "A String", # Output only. Timestamp when the tool was last updated.
+    "widgetTool": { # Represents a widget tool that the agent can invoke. When the tool is chosen by the agent, agent will return the widget to the client. The client is responsible for processing the widget and generating the next user query to continue the interaction with the agent. # Optional. The widget tool.
+      "dataMapping": { # Configuration for mapping data from a source tool to the widget's input parameters. # Optional. The mapping that defines how data from a source tool is mapped to the widget's input parameters.
+        "fieldMappings": { # Optional. A map of widget input parameter fields to the corresponding output fields of the source tool.
+          "a_key": "A String",
+        },
+        "mode": "A String", # Optional. The mode of the data mapping.
+        "pythonFunction": { # A Python function tool. # Optional. Configuration for a Python function used to transform the source tool's output into the widget's input format.
+          "description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring.
+          "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used.
+          "pythonCode": "A String", # Optional. The Python code to execute for the tool.
+        },
+        "pythonScript": "A String", # Deprecated: Use `python_function` instead.
+        "sourceToolName": "A String", # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}`
+      },
+      "description": "A String", # Optional. The description of the widget tool.
+      "name": "A String", # Required. The display name of the widget tool.
+      "parameters": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The input parameters of the widget tool.
+        "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties.
+        "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
+          # Object with schema name: Schema
+        ],
+        "default": "", # Optional. Default value of the data.
+        "defs": { # Optional. A map of definitions for use by `ref`. Only allowed at the root of the schema.
+          "a_key": # Object with schema name: Schema
+        },
+        "description": "A String", # Optional. The description of the data.
+        "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
+          "A String",
+        ],
+        "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY.
+        "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
+        "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER.
+        "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
+        "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER.
+        "nullable": True or False, # Optional. Indicates if the value may be null.
+        "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY.
+          # Object with schema name: Schema
+        ],
+        "properties": { # Optional. Properties of Type.OBJECT.
+          "a_key": # Object with schema name: Schema
+        },
+        "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+        "required": [ # Optional. Required properties of Type.OBJECT.
+          "A String",
+        ],
+        "title": "A String", # Optional. The title of the schema.
+        "type": "A String", # Required. The type of the data.
+        "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
+      },
+      "uiConfig": { # Optional. Configuration for rendering the widget.
+        "a_key": "", # Properties of the object.
+      },
+      "widgetType": "A String", # Optional. The type of the widget tool. If not specified, the default type will be CUSTOMIZED.
+    },
+  },
+  "toolGenerationConfig": { # The configuration to be used to generate a tool. # Optional. The configuration to be used to generate the tool.
+    "context": "A String", # Optional. The context which describes the tool to be generated. This can be empty if the tool request & response are provided.
+    "fileContexts": [ # Optional. The files to be used as context.
+      { # Files to be used as context. Files can be provided as raw bytes.
+        "fileBytes": { # File provided as raw bytes. # Optional. File provided as raw bytes.
+          "data": "A String", # Required. Raw bytes of the file.
+          "fileName": "A String", # Required. The name of the file provided as raw bytes.
+          "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+        },
+      },
+    ],
+    "openApiToolsetGenerationConfig": { # The configuration to be used to generate an Open API schema. # Optional. The configuration to be used to generate an Open API schema.
+      "operationGenerationConfigs": [ # Required. The list of operations to be added to the Open API schema.
+        { # The configuration to be used to generate an operation in the Open API schema.
+          "method": "A String", # Required. The uri of the tool. This should include query and path parameters if any.
+          "path": "A String", # Required. The path of the tool to be appended to the base uri. This should include query and path parameters if any.
+          "requestJson": "A String", # Required. A sample request to the tool in JSON format. Skip if the tool does not support request body.
+          "responseJson": "A String", # Required. A sample response from the tool in JSON format.
+        },
+      ],
+      "uri": "A String", # Required. The base uri of the tool.
+    },
+  },
+  "toolset": { # A toolset represents a group of dynamically managed tools that can be used by the agent. # The toolset resource to be used by the LLM assistant, can be empty for generating a new toolset.
+    "connectorToolset": { # A toolset that generates tools from an Integration Connectors Connection. # Optional. A toolset that generates tools from an Integration Connectors Connection.
+      "authConfig": { # End-user authentication configuration used for Connection calls. The field values must be the names of context variables in the format `$context.variables.`. # Optional. Configures how authentication is handled in Integration Connectors. By default, an admin authentication is passed in the Integration Connectors API requests. You can override it with a different end-user authentication config. **Note**: The Connection must have authentication override enabled in order to specify an EUC configuration here - otherwise, the Toolset creation will fail. See: https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override
+        "oauth2AuthCodeConfig": { # Oauth 2.0 Authorization Code authentication configuration. # Oauth 2.0 Authorization Code authentication.
+          "oauthToken": "A String", # Required. Oauth token parameter name to pass through. Must be in the format `$context.variables.`.
+        },
+        "oauth2JwtBearerConfig": { # JWT Profile Oauth 2.0 Authorization Grant authentication configuration. # JWT Profile Oauth 2.0 Authorization Grant authentication.
+          "clientKey": "A String", # Required. Client parameter name to pass through. Must be in the format `$context.variables.`.
+          "issuer": "A String", # Required. Issuer parameter name to pass through. Must be in the format `$context.variables.`.
+          "subject": "A String", # Required. Subject parameter name to pass through. Must be in the format `$context.variables.`.
+        },
+      },
+      "connection": "A String", # Required. The full resource name of the referenced Integration Connectors Connection. Format: `projects/{project}/locations/{location}/connections/{connection}`
+      "connectorActions": [ # Required. The list of connector actions/entity operations to generate tools for.
+        { # Configuration of an Action for the tool to use. Note: This can be either an Action or an Operation. See https://cloud.google.com/integration-connectors/docs/entities-operation-action for details.
+          "connectionActionId": "A String", # ID of a Connection action for the tool to use.
+          "entityOperation": { # Entity CRUD operation specification. # Entity operation configuration for the tool to use.
+            "entityId": "A String", # Required. ID of the entity.
+            "operation": "A String", # Required. Operation to perform on the entity.
+          },
+          "inputFields": [ # Optional. Entity fields to use as inputs for the operation. If no fields are specified, all fields of the Entity will be used.
+            "A String",
+          ],
+          "outputFields": [ # Optional. Entity fields to return from the operation. If no fields are specified, all fields of the Entity will be returned.
+            "A String",
+          ],
+        },
+      ],
+    },
+    "createTime": "A String", # Output only. Timestamp when the toolset was created.
+    "description": "A String", # Optional. The description of the toolset.
+    "displayName": "A String", # Optional. The display name of the toolset. Must be unique within the same app.
+    "etag": "A String", # ETag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
+    "executionType": "A String", # Optional. The execution type of the tools in the toolset.
+    "mcpToolset": { # A toolset that contains a list of tools that are offered by the MCP server. # Optional. A toolset that contains a list of tools that are offered by the MCP server.
+      "apiAuthentication": { # Authentication information required for API calls. # Optional. Authentication information required to access tools and execute a tool against the MCP server. For bearer token authentication, the token applies only to tool execution, not to listing tools. This requires that tools can be listed without authentication.
+        "apiKeyConfig": { # Configurations for authentication with API key. # Optional. Config for API key auth.
+          "apiKeySecretVersion": "A String", # Required. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+          "keyName": "A String", # Required. The parameter name or the header name of the API key. E.g., If the API request is "https://example.com/act?X-Api-Key=", "X-Api-Key" would be the parameter name.
+          "requestLocation": "A String", # Required. Key location in the request.
+        },
+        "bearerTokenConfig": { # Configurations for authentication with a bearer token. # Optional. Config for bearer token auth.
+          "token": "A String", # Required. The bearer token. Must be in the format `$context.variables.`.
+        },
+        "oauthConfig": { # Configurations for authentication with OAuth. # Optional. Config for OAuth.
+          "clientId": "A String", # Required. The client ID from the OAuth provider.
+          "clientSecretVersion": "A String", # Required. The name of the SecretManager secret version resource storing the client secret. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+          "oauthGrantType": "A String", # Required. OAuth grant types.
+          "scopes": [ # Optional. The OAuth scopes to grant.
+            "A String",
+          ],
+          "tokenEndpoint": "A String", # Required. The token endpoint in the OAuth provider to exchange for an access token.
+        },
+        "serviceAccountAuthConfig": { # Configurations for authentication using a custom service account. # Optional. Config for service account authentication.
+          "scopes": [ # Optional. The OAuth scopes to grant. If not specified, the default scope `https://www.googleapis.com/auth/cloud-platform` is used.
+            "A String",
+          ],
+          "serviceAccount": "A String", # Required. The email address of the service account used for authentication. CES uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+        },
+        "serviceAgentIdTokenAuthConfig": { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent.
+        },
+      },
+      "customHeaders": { # Optional. The custom headers to send in the request to the MCP server. The values must be in the format `$context.variables.` and can be set in the session variables. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection for more details.
+        "a_key": "A String",
+      },
+      "serverAddress": "A String", # Required. The address of the MCP server, for example, "https://example.com/mcp/". If the server is built with the MCP SDK, the url should be suffixed with "/mcp/". Only Streamable HTTP transport based servers are supported. See https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http for more details.
+      "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter.
+        "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app.
+      },
+      "tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust.
+        "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification.
+          { # The CA certificate.
+            "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ```
+            "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates.
+          },
+        ],
+      },
+    },
+    "name": "A String", # Identifier. The unique identifier of the toolset. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`
+    "openApiToolset": { # A toolset that contains a list of tools that are defined by an OpenAPI schema. # Optional. A toolset that contains a list of tools that are defined by an OpenAPI schema.
+      "apiAuthentication": { # Authentication information required for API calls. # Optional. Authentication information required by the API.
+        "apiKeyConfig": { # Configurations for authentication with API key. # Optional. Config for API key auth.
+          "apiKeySecretVersion": "A String", # Required. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+          "keyName": "A String", # Required. The parameter name or the header name of the API key. E.g., If the API request is "https://example.com/act?X-Api-Key=", "X-Api-Key" would be the parameter name.
+          "requestLocation": "A String", # Required. Key location in the request.
+        },
+        "bearerTokenConfig": { # Configurations for authentication with a bearer token. # Optional. Config for bearer token auth.
+          "token": "A String", # Required. The bearer token. Must be in the format `$context.variables.`.
+        },
+        "oauthConfig": { # Configurations for authentication with OAuth. # Optional. Config for OAuth.
+          "clientId": "A String", # Required. The client ID from the OAuth provider.
+          "clientSecretVersion": "A String", # Required. The name of the SecretManager secret version resource storing the client secret. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+          "oauthGrantType": "A String", # Required. OAuth grant types.
+          "scopes": [ # Optional. The OAuth scopes to grant.
+            "A String",
+          ],
+          "tokenEndpoint": "A String", # Required. The token endpoint in the OAuth provider to exchange for an access token.
+        },
+        "serviceAccountAuthConfig": { # Configurations for authentication using a custom service account. # Optional. Config for service account authentication.
+          "scopes": [ # Optional. The OAuth scopes to grant. If not specified, the default scope `https://www.googleapis.com/auth/cloud-platform` is used.
+            "A String",
+          ],
+          "serviceAccount": "A String", # Required. The email address of the service account used for authentication. CES uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+        },
+        "serviceAgentIdTokenAuthConfig": { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent.
+        },
+      },
+      "ignoreUnknownFields": True or False, # Optional. If true, the agent will ignore unknown fields in the API response for all operations defined in the OpenAPI schema.
+      "openApiSchema": "A String", # Required. The OpenAPI schema of the toolset.
+      "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration.
+        "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app.
+      },
+      "tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates
+        "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification.
+          { # The CA certificate.
+            "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ```
+            "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates.
+          },
+        ],
+      },
+      "url": "A String", # Optional. The server URL of the Open API schema. This field is only set in toolsets in the environment dependencies during the export process if the schema contains a server url. During the import process, if this url is present in the environment dependencies and the schema has the $env_var placeholder, it will replace the placeholder in the schema.
+    },
+    "toolFakeConfig": { # Configuration for tool behavior in fake mode. # Optional. Configuration for tools behavior in fake mode.
+      "codeBlock": { # A code block to be executed instead of a real tool call. # Optional. Code block which will be executed instead of a real tool call.
+        "pythonCode": "A String", # Required. Python code which will be invoked in tool fake mode. Expected Python function signature - To catch all tool calls: def fake_tool_call(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: To catch a specific tool call: def fake_{tool_id}(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: If the function returns None, the real tool will be invoked instead.
+      },
+      "enableFakeMode": True or False, # Optional. Whether the tool is using fake mode.
+    },
+    "updateTime": "A String", # Output only. Timestamp when the toolset was last updated.
+  },
+}
+
+  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, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+
get(name, x__xgafv=None)
Gets details of the specified app.
@@ -725,7 +1546,7 @@ 

Method Details

"languageSettings": { # Language settings of the app. # Optional. Language settings of the app. "defaultLanguageCode": "A String", # Optional. The default language code of the app. "enableMultilingualSupport": True or False, # Optional. Enables multilingual support. If true, agents in the app will use pre-built instructions to improve handling of multilingual input. - "fallbackAction": "A String", # Optional. The action to perform when an agent receives input in an unsupported language. This can be a predefined action or a custom tool call. Valid values are: - A tool's full resource name, which triggers a specific tool execution. - A predefined system action, such as "escalate" or "exit", which triggers an EndSession signal with corresponding metadata to terminate the conversation. + "fallbackAction": "A String", # Optional. Deprecated: This feature is no longer supported. Use `enable_multilingual_support` instead to improve handling of multilingual input. The action to perform when an agent receives input in an unsupported language. This can be a predefined action or a custom tool call. Valid values are: - A tool's full resource name, which triggers a specific tool execution. - A predefined system action, such as "escalate" or "exit", which triggers an EndSession signal with corresponding metadata to terminate the conversation. "supportedLanguageCodes": [ # Optional. List of languages codes supported by the app, in addition to the `default_language_code`. "A String", ], @@ -1084,7 +1905,7 @@

Method Details

"languageSettings": { # Language settings of the app. # Optional. Language settings of the app. "defaultLanguageCode": "A String", # Optional. The default language code of the app. "enableMultilingualSupport": True or False, # Optional. Enables multilingual support. If true, agents in the app will use pre-built instructions to improve handling of multilingual input. - "fallbackAction": "A String", # Optional. The action to perform when an agent receives input in an unsupported language. This can be a predefined action or a custom tool call. Valid values are: - A tool's full resource name, which triggers a specific tool execution. - A predefined system action, such as "escalate" or "exit", which triggers an EndSession signal with corresponding metadata to terminate the conversation. + "fallbackAction": "A String", # Optional. Deprecated: This feature is no longer supported. Use `enable_multilingual_support` instead to improve handling of multilingual input. The action to perform when an agent receives input in an unsupported language. This can be a predefined action or a custom tool call. Valid values are: - A tool's full resource name, which triggers a specific tool execution. - A predefined system action, such as "escalate" or "exit", which triggers an EndSession signal with corresponding metadata to terminate the conversation. "supportedLanguageCodes": [ # Optional. List of languages codes supported by the app, in addition to the `default_language_code`. "A String", ], @@ -1352,7 +2173,7 @@

Method Details

"languageSettings": { # Language settings of the app. # Optional. Language settings of the app. "defaultLanguageCode": "A String", # Optional. The default language code of the app. "enableMultilingualSupport": True or False, # Optional. Enables multilingual support. If true, agents in the app will use pre-built instructions to improve handling of multilingual input. - "fallbackAction": "A String", # Optional. The action to perform when an agent receives input in an unsupported language. This can be a predefined action or a custom tool call. Valid values are: - A tool's full resource name, which triggers a specific tool execution. - A predefined system action, such as "escalate" or "exit", which triggers an EndSession signal with corresponding metadata to terminate the conversation. + "fallbackAction": "A String", # Optional. Deprecated: This feature is no longer supported. Use `enable_multilingual_support` instead to improve handling of multilingual input. The action to perform when an agent receives input in an unsupported language. This can be a predefined action or a custom tool call. Valid values are: - A tool's full resource name, which triggers a specific tool execution. - A predefined system action, such as "escalate" or "exit", which triggers an EndSession signal with corresponding metadata to terminate the conversation. "supportedLanguageCodes": [ # Optional. List of languages codes supported by the app, in addition to the `default_language_code`. "A String", ], @@ -1599,7 +2420,7 @@

Method Details

"languageSettings": { # Language settings of the app. # Optional. Language settings of the app. "defaultLanguageCode": "A String", # Optional. The default language code of the app. "enableMultilingualSupport": True or False, # Optional. Enables multilingual support. If true, agents in the app will use pre-built instructions to improve handling of multilingual input. - "fallbackAction": "A String", # Optional. The action to perform when an agent receives input in an unsupported language. This can be a predefined action or a custom tool call. Valid values are: - A tool's full resource name, which triggers a specific tool execution. - A predefined system action, such as "escalate" or "exit", which triggers an EndSession signal with corresponding metadata to terminate the conversation. + "fallbackAction": "A String", # Optional. Deprecated: This feature is no longer supported. Use `enable_multilingual_support` instead to improve handling of multilingual input. The action to perform when an agent receives input in an unsupported language. This can be a predefined action or a custom tool call. Valid values are: - A tool's full resource name, which triggers a specific tool execution. - A predefined system action, such as "escalate" or "exit", which triggers an EndSession signal with corresponding metadata to terminate the conversation. "supportedLanguageCodes": [ # Optional. List of languages codes supported by the app, in addition to the `default_language_code`. "A String", ], diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.versions.html b/docs/dyn/ces_v1beta.projects.locations.apps.versions.html index 0d78c5e1b8..ac6cedaab0 100644 --- a/docs/dyn/ces_v1beta.projects.locations.apps.versions.html +++ b/docs/dyn/ces_v1beta.projects.locations.apps.versions.html @@ -340,7 +340,7 @@

Method Details

"languageSettings": { # Language settings of the app. # Optional. Language settings of the app. "defaultLanguageCode": "A String", # Optional. The default language code of the app. "enableMultilingualSupport": True or False, # Optional. Enables multilingual support. If true, agents in the app will use pre-built instructions to improve handling of multilingual input. - "fallbackAction": "A String", # Optional. The action to perform when an agent receives input in an unsupported language. This can be a predefined action or a custom tool call. Valid values are: - A tool's full resource name, which triggers a specific tool execution. - A predefined system action, such as "escalate" or "exit", which triggers an EndSession signal with corresponding metadata to terminate the conversation. + "fallbackAction": "A String", # Optional. Deprecated: This feature is no longer supported. Use `enable_multilingual_support` instead to improve handling of multilingual input. The action to perform when an agent receives input in an unsupported language. This can be a predefined action or a custom tool call. Valid values are: - A tool's full resource name, which triggers a specific tool execution. - A predefined system action, such as "escalate" or "exit", which triggers an EndSession signal with corresponding metadata to terminate the conversation. "supportedLanguageCodes": [ # Optional. List of languages codes supported by the app, in addition to the `default_language_code`. "A String", ], @@ -1471,7 +1471,7 @@

Method Details

"languageSettings": { # Language settings of the app. # Optional. Language settings of the app. "defaultLanguageCode": "A String", # Optional. The default language code of the app. "enableMultilingualSupport": True or False, # Optional. Enables multilingual support. If true, agents in the app will use pre-built instructions to improve handling of multilingual input. - "fallbackAction": "A String", # Optional. The action to perform when an agent receives input in an unsupported language. This can be a predefined action or a custom tool call. Valid values are: - A tool's full resource name, which triggers a specific tool execution. - A predefined system action, such as "escalate" or "exit", which triggers an EndSession signal with corresponding metadata to terminate the conversation. + "fallbackAction": "A String", # Optional. Deprecated: This feature is no longer supported. Use `enable_multilingual_support` instead to improve handling of multilingual input. The action to perform when an agent receives input in an unsupported language. This can be a predefined action or a custom tool call. Valid values are: - A tool's full resource name, which triggers a specific tool execution. - A predefined system action, such as "escalate" or "exit", which triggers an EndSession signal with corresponding metadata to terminate the conversation. "supportedLanguageCodes": [ # Optional. List of languages codes supported by the app, in addition to the `default_language_code`. "A String", ], @@ -2627,7 +2627,7 @@

Method Details

"languageSettings": { # Language settings of the app. # Optional. Language settings of the app. "defaultLanguageCode": "A String", # Optional. The default language code of the app. "enableMultilingualSupport": True or False, # Optional. Enables multilingual support. If true, agents in the app will use pre-built instructions to improve handling of multilingual input. - "fallbackAction": "A String", # Optional. The action to perform when an agent receives input in an unsupported language. This can be a predefined action or a custom tool call. Valid values are: - A tool's full resource name, which triggers a specific tool execution. - A predefined system action, such as "escalate" or "exit", which triggers an EndSession signal with corresponding metadata to terminate the conversation. + "fallbackAction": "A String", # Optional. Deprecated: This feature is no longer supported. Use `enable_multilingual_support` instead to improve handling of multilingual input. The action to perform when an agent receives input in an unsupported language. This can be a predefined action or a custom tool call. Valid values are: - A tool's full resource name, which triggers a specific tool execution. - A predefined system action, such as "escalate" or "exit", which triggers an EndSession signal with corresponding metadata to terminate the conversation. "supportedLanguageCodes": [ # Optional. List of languages codes supported by the app, in addition to the `default_language_code`. "A String", ], @@ -3770,7 +3770,7 @@

Method Details

"languageSettings": { # Language settings of the app. # Optional. Language settings of the app. "defaultLanguageCode": "A String", # Optional. The default language code of the app. "enableMultilingualSupport": True or False, # Optional. Enables multilingual support. If true, agents in the app will use pre-built instructions to improve handling of multilingual input. - "fallbackAction": "A String", # Optional. The action to perform when an agent receives input in an unsupported language. This can be a predefined action or a custom tool call. Valid values are: - A tool's full resource name, which triggers a specific tool execution. - A predefined system action, such as "escalate" or "exit", which triggers an EndSession signal with corresponding metadata to terminate the conversation. + "fallbackAction": "A String", # Optional. Deprecated: This feature is no longer supported. Use `enable_multilingual_support` instead to improve handling of multilingual input. The action to perform when an agent receives input in an unsupported language. This can be a predefined action or a custom tool call. Valid values are: - A tool's full resource name, which triggers a specific tool execution. - A predefined system action, such as "escalate" or "exit", which triggers an EndSession signal with corresponding metadata to terminate the conversation. "supportedLanguageCodes": [ # Optional. List of languages codes supported by the app, in addition to the `default_language_code`. "A String", ], diff --git a/docs/dyn/ces_v1beta.projects.locations.html b/docs/dyn/ces_v1beta.projects.locations.html index a56f6191ed..55e798122b 100644 --- a/docs/dyn/ces_v1beta.projects.locations.html +++ b/docs/dyn/ces_v1beta.projects.locations.html @@ -95,7 +95,7 @@

Instance Methods

Retrieves the security settings for the project and location.

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

-

Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.

+

Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.

list_next()

Retrieves the next page of results.

@@ -165,7 +165,7 @@

Method Details

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
+  
Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
diff --git a/docs/dyn/chat_v1.spaces.messages.html b/docs/dyn/chat_v1.spaces.messages.html
index f18c26dd98..ae1c354dfb 100644
--- a/docs/dyn/chat_v1.spaces.messages.html
+++ b/docs/dyn/chat_v1.spaces.messages.html
@@ -166,7 +166,7 @@ 

Method Details

"A String", ], }, - "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. Any widgets beyond this limit are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A new card is pushed to the card stack after clicking if specified. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): + "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. If a section's widgets push the total count above 100, that entire section and all following sections are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A new card is pushed to the card stack after clicking if specified. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): "cardActions": [ # The card's actions. Actions are added to the card's toolbar menu. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): For example, the following JSON constructs a card action menu with `Settings` and `Send Feedback` options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ] ``` { # A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): "actionLabel": "A String", # The label that displays as the action menu item. @@ -1030,7 +1030,7 @@

Method Details

"userFacingMessage": "A String", # The message to send users about the status of their request. If unset, a generic message based on the `status_code` is sent. }, "dialog": { # Wrapper around the card body of the dialog. # Input only. [Dialog](https://developers.google.com/workspace/chat/dialogs) for the request. - "body": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. Any widgets beyond this limit are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # Input only. Body of the dialog, which is rendered in a modal. Google Chat apps don't support the following card entities: `DateTimePicker`, `OnChangeAction`. + "body": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. If a section's widgets push the total count above 100, that entire section and all following sections are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # Input only. Body of the dialog, which is rendered in a modal. Google Chat apps don't support the following card entities: `DateTimePicker`, `OnChangeAction`. "cardActions": [ # The card's actions. Actions are added to the card's toolbar menu. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): For example, the following JSON constructs a card action menu with `Settings` and `Send Feedback` options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ] ``` { # A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): "actionLabel": "A String", # The label that displays as the action menu item. @@ -2107,7 +2107,7 @@

Method Details

], "cardsV2": [ # Optional. An array of [cards](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards). Chat apps can create cards with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). As part of the [Developer Preview Program](https://developers.google.com/workspace/preview), if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), it can create card messages. If your Chat app is not part of Developer Preview Program, it can't create cards with user authentication. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) { # A [card](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards) in a Google Chat message. Chat apps can create cards with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). As part of the [Developer Preview Program](https://developers.google.com/workspace/preview), if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), it can create card messages. If your Chat app is not part of Developer Preview Program, it can't create cards with user authentication. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) - "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. Any widgets beyond this limit are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A card. Maximum size is 32 KB. + "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. If a section's widgets push the total count above 100, that entire section and all following sections are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A card. Maximum size is 32 KB. "cardActions": [ # The card's actions. Actions are added to the card's toolbar menu. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): For example, the following JSON constructs a card action menu with `Settings` and `Send Feedback` options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ] ``` { # A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): "actionLabel": "A String", # The label that displays as the action menu item. @@ -3202,7 +3202,7 @@

Method Details

"A String", ], }, - "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. Any widgets beyond this limit are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A new card is pushed to the card stack after clicking if specified. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): + "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. If a section's widgets push the total count above 100, that entire section and all following sections are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A new card is pushed to the card stack after clicking if specified. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): "cardActions": [ # The card's actions. Actions are added to the card's toolbar menu. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): For example, the following JSON constructs a card action menu with `Settings` and `Send Feedback` options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ] ``` { # A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): "actionLabel": "A String", # The label that displays as the action menu item. @@ -4066,7 +4066,7 @@

Method Details

"userFacingMessage": "A String", # The message to send users about the status of their request. If unset, a generic message based on the `status_code` is sent. }, "dialog": { # Wrapper around the card body of the dialog. # Input only. [Dialog](https://developers.google.com/workspace/chat/dialogs) for the request. - "body": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. Any widgets beyond this limit are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # Input only. Body of the dialog, which is rendered in a modal. Google Chat apps don't support the following card entities: `DateTimePicker`, `OnChangeAction`. + "body": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. If a section's widgets push the total count above 100, that entire section and all following sections are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # Input only. Body of the dialog, which is rendered in a modal. Google Chat apps don't support the following card entities: `DateTimePicker`, `OnChangeAction`. "cardActions": [ # The card's actions. Actions are added to the card's toolbar menu. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): For example, the following JSON constructs a card action menu with `Settings` and `Send Feedback` options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ] ``` { # A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): "actionLabel": "A String", # The label that displays as the action menu item. @@ -5143,7 +5143,7 @@

Method Details

], "cardsV2": [ # Optional. An array of [cards](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards). Chat apps can create cards with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). As part of the [Developer Preview Program](https://developers.google.com/workspace/preview), if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), it can create card messages. If your Chat app is not part of Developer Preview Program, it can't create cards with user authentication. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) { # A [card](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards) in a Google Chat message. Chat apps can create cards with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). As part of the [Developer Preview Program](https://developers.google.com/workspace/preview), if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), it can create card messages. If your Chat app is not part of Developer Preview Program, it can't create cards with user authentication. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) - "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. Any widgets beyond this limit are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A card. Maximum size is 32 KB. + "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. If a section's widgets push the total count above 100, that entire section and all following sections are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A card. Maximum size is 32 KB. "cardActions": [ # The card's actions. Actions are added to the card's toolbar menu. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): For example, the following JSON constructs a card action menu with `Settings` and `Send Feedback` options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ] ``` { # A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): "actionLabel": "A String", # The label that displays as the action menu item. @@ -6256,7 +6256,7 @@

Method Details

"A String", ], }, - "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. Any widgets beyond this limit are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A new card is pushed to the card stack after clicking if specified. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): + "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. If a section's widgets push the total count above 100, that entire section and all following sections are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A new card is pushed to the card stack after clicking if specified. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): "cardActions": [ # The card's actions. Actions are added to the card's toolbar menu. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): For example, the following JSON constructs a card action menu with `Settings` and `Send Feedback` options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ] ``` { # A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): "actionLabel": "A String", # The label that displays as the action menu item. @@ -7120,7 +7120,7 @@

Method Details

"userFacingMessage": "A String", # The message to send users about the status of their request. If unset, a generic message based on the `status_code` is sent. }, "dialog": { # Wrapper around the card body of the dialog. # Input only. [Dialog](https://developers.google.com/workspace/chat/dialogs) for the request. - "body": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. Any widgets beyond this limit are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # Input only. Body of the dialog, which is rendered in a modal. Google Chat apps don't support the following card entities: `DateTimePicker`, `OnChangeAction`. + "body": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. If a section's widgets push the total count above 100, that entire section and all following sections are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # Input only. Body of the dialog, which is rendered in a modal. Google Chat apps don't support the following card entities: `DateTimePicker`, `OnChangeAction`. "cardActions": [ # The card's actions. Actions are added to the card's toolbar menu. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): For example, the following JSON constructs a card action menu with `Settings` and `Send Feedback` options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ] ``` { # A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): "actionLabel": "A String", # The label that displays as the action menu item. @@ -8197,7 +8197,7 @@

Method Details

], "cardsV2": [ # Optional. An array of [cards](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards). Chat apps can create cards with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). As part of the [Developer Preview Program](https://developers.google.com/workspace/preview), if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), it can create card messages. If your Chat app is not part of Developer Preview Program, it can't create cards with user authentication. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) { # A [card](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards) in a Google Chat message. Chat apps can create cards with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). As part of the [Developer Preview Program](https://developers.google.com/workspace/preview), if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), it can create card messages. If your Chat app is not part of Developer Preview Program, it can't create cards with user authentication. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) - "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. Any widgets beyond this limit are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A card. Maximum size is 32 KB. + "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. If a section's widgets push the total count above 100, that entire section and all following sections are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A card. Maximum size is 32 KB. "cardActions": [ # The card's actions. Actions are added to the card's toolbar menu. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): For example, the following JSON constructs a card action menu with `Settings` and `Send Feedback` options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ] ``` { # A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): "actionLabel": "A String", # The label that displays as the action menu item. @@ -9298,7 +9298,7 @@

Method Details

"A String", ], }, - "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. Any widgets beyond this limit are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A new card is pushed to the card stack after clicking if specified. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): + "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. If a section's widgets push the total count above 100, that entire section and all following sections are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A new card is pushed to the card stack after clicking if specified. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): "cardActions": [ # The card's actions. Actions are added to the card's toolbar menu. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): For example, the following JSON constructs a card action menu with `Settings` and `Send Feedback` options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ] ``` { # A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): "actionLabel": "A String", # The label that displays as the action menu item. @@ -10162,7 +10162,7 @@

Method Details

"userFacingMessage": "A String", # The message to send users about the status of their request. If unset, a generic message based on the `status_code` is sent. }, "dialog": { # Wrapper around the card body of the dialog. # Input only. [Dialog](https://developers.google.com/workspace/chat/dialogs) for the request. - "body": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. Any widgets beyond this limit are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # Input only. Body of the dialog, which is rendered in a modal. Google Chat apps don't support the following card entities: `DateTimePicker`, `OnChangeAction`. + "body": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. If a section's widgets push the total count above 100, that entire section and all following sections are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # Input only. Body of the dialog, which is rendered in a modal. Google Chat apps don't support the following card entities: `DateTimePicker`, `OnChangeAction`. "cardActions": [ # The card's actions. Actions are added to the card's toolbar menu. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): For example, the following JSON constructs a card action menu with `Settings` and `Send Feedback` options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ] ``` { # A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): "actionLabel": "A String", # The label that displays as the action menu item. @@ -11239,7 +11239,7 @@

Method Details

], "cardsV2": [ # Optional. An array of [cards](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards). Chat apps can create cards with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). As part of the [Developer Preview Program](https://developers.google.com/workspace/preview), if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), it can create card messages. If your Chat app is not part of Developer Preview Program, it can't create cards with user authentication. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) { # A [card](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards) in a Google Chat message. Chat apps can create cards with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). As part of the [Developer Preview Program](https://developers.google.com/workspace/preview), if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), it can create card messages. If your Chat app is not part of Developer Preview Program, it can't create cards with user authentication. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) - "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. Any widgets beyond this limit are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A card. Maximum size is 32 KB. + "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. If a section's widgets push the total count above 100, that entire section and all following sections are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A card. Maximum size is 32 KB. "cardActions": [ # The card's actions. Actions are added to the card's toolbar menu. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): For example, the following JSON constructs a card action menu with `Settings` and `Send Feedback` options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ] ``` { # A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): "actionLabel": "A String", # The label that displays as the action menu item. @@ -12345,7 +12345,7 @@

Method Details

"A String", ], }, - "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. Any widgets beyond this limit are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A new card is pushed to the card stack after clicking if specified. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): + "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. If a section's widgets push the total count above 100, that entire section and all following sections are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A new card is pushed to the card stack after clicking if specified. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): "cardActions": [ # The card's actions. Actions are added to the card's toolbar menu. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): For example, the following JSON constructs a card action menu with `Settings` and `Send Feedback` options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ] ``` { # A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): "actionLabel": "A String", # The label that displays as the action menu item. @@ -13209,7 +13209,7 @@

Method Details

"userFacingMessage": "A String", # The message to send users about the status of their request. If unset, a generic message based on the `status_code` is sent. }, "dialog": { # Wrapper around the card body of the dialog. # Input only. [Dialog](https://developers.google.com/workspace/chat/dialogs) for the request. - "body": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. Any widgets beyond this limit are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # Input only. Body of the dialog, which is rendered in a modal. Google Chat apps don't support the following card entities: `DateTimePicker`, `OnChangeAction`. + "body": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. If a section's widgets push the total count above 100, that entire section and all following sections are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # Input only. Body of the dialog, which is rendered in a modal. Google Chat apps don't support the following card entities: `DateTimePicker`, `OnChangeAction`. "cardActions": [ # The card's actions. Actions are added to the card's toolbar menu. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): For example, the following JSON constructs a card action menu with `Settings` and `Send Feedback` options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ] ``` { # A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): "actionLabel": "A String", # The label that displays as the action menu item. @@ -14286,7 +14286,7 @@

Method Details

], "cardsV2": [ # Optional. An array of [cards](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards). Chat apps can create cards with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). As part of the [Developer Preview Program](https://developers.google.com/workspace/preview), if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), it can create card messages. If your Chat app is not part of Developer Preview Program, it can't create cards with user authentication. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) { # A [card](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards) in a Google Chat message. Chat apps can create cards with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). As part of the [Developer Preview Program](https://developers.google.com/workspace/preview), if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), it can create card messages. If your Chat app is not part of Developer Preview Program, it can't create cards with user authentication. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) - "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. Any widgets beyond this limit are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A card. Maximum size is 32 KB. + "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. If a section's widgets push the total count above 100, that entire section and all following sections are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A card. Maximum size is 32 KB. "cardActions": [ # The card's actions. Actions are added to the card's toolbar menu. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): For example, the following JSON constructs a card action menu with `Settings` and `Send Feedback` options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ] ``` { # A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): "actionLabel": "A String", # The label that displays as the action menu item. @@ -15375,7 +15375,7 @@

Method Details

"A String", ], }, - "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. Any widgets beyond this limit are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A new card is pushed to the card stack after clicking if specified. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): + "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. If a section's widgets push the total count above 100, that entire section and all following sections are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A new card is pushed to the card stack after clicking if specified. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): "cardActions": [ # The card's actions. Actions are added to the card's toolbar menu. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): For example, the following JSON constructs a card action menu with `Settings` and `Send Feedback` options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ] ``` { # A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): "actionLabel": "A String", # The label that displays as the action menu item. @@ -16239,7 +16239,7 @@

Method Details

"userFacingMessage": "A String", # The message to send users about the status of their request. If unset, a generic message based on the `status_code` is sent. }, "dialog": { # Wrapper around the card body of the dialog. # Input only. [Dialog](https://developers.google.com/workspace/chat/dialogs) for the request. - "body": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. Any widgets beyond this limit are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # Input only. Body of the dialog, which is rendered in a modal. Google Chat apps don't support the following card entities: `DateTimePicker`, `OnChangeAction`. + "body": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. If a section's widgets push the total count above 100, that entire section and all following sections are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # Input only. Body of the dialog, which is rendered in a modal. Google Chat apps don't support the following card entities: `DateTimePicker`, `OnChangeAction`. "cardActions": [ # The card's actions. Actions are added to the card's toolbar menu. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): For example, the following JSON constructs a card action menu with `Settings` and `Send Feedback` options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ] ``` { # A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): "actionLabel": "A String", # The label that displays as the action menu item. @@ -17316,7 +17316,7 @@

Method Details

], "cardsV2": [ # Optional. An array of [cards](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards). Chat apps can create cards with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). As part of the [Developer Preview Program](https://developers.google.com/workspace/preview), if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), it can create card messages. If your Chat app is not part of Developer Preview Program, it can't create cards with user authentication. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) { # A [card](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards) in a Google Chat message. Chat apps can create cards with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). As part of the [Developer Preview Program](https://developers.google.com/workspace/preview), if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), it can create card messages. If your Chat app is not part of Developer Preview Program, it can't create cards with user authentication. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) - "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. Any widgets beyond this limit are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A card. Maximum size is 32 KB. + "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. If a section's widgets push the total count above 100, that entire section and all following sections are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A card. Maximum size is 32 KB. "cardActions": [ # The card's actions. Actions are added to the card's toolbar menu. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): For example, the following JSON constructs a card action menu with `Settings` and `Send Feedback` options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ] ``` { # A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): "actionLabel": "A String", # The label that displays as the action menu item. @@ -18405,7 +18405,7 @@

Method Details

"A String", ], }, - "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. Any widgets beyond this limit are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A new card is pushed to the card stack after clicking if specified. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): + "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. If a section's widgets push the total count above 100, that entire section and all following sections are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A new card is pushed to the card stack after clicking if specified. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): "cardActions": [ # The card's actions. Actions are added to the card's toolbar menu. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): For example, the following JSON constructs a card action menu with `Settings` and `Send Feedback` options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ] ``` { # A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): "actionLabel": "A String", # The label that displays as the action menu item. @@ -19269,7 +19269,7 @@

Method Details

"userFacingMessage": "A String", # The message to send users about the status of their request. If unset, a generic message based on the `status_code` is sent. }, "dialog": { # Wrapper around the card body of the dialog. # Input only. [Dialog](https://developers.google.com/workspace/chat/dialogs) for the request. - "body": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. Any widgets beyond this limit are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # Input only. Body of the dialog, which is rendered in a modal. Google Chat apps don't support the following card entities: `DateTimePicker`, `OnChangeAction`. + "body": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. If a section's widgets push the total count above 100, that entire section and all following sections are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # Input only. Body of the dialog, which is rendered in a modal. Google Chat apps don't support the following card entities: `DateTimePicker`, `OnChangeAction`. "cardActions": [ # The card's actions. Actions are added to the card's toolbar menu. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): For example, the following JSON constructs a card action menu with `Settings` and `Send Feedback` options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ] ``` { # A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): "actionLabel": "A String", # The label that displays as the action menu item. @@ -20346,7 +20346,7 @@

Method Details

], "cardsV2": [ # Optional. An array of [cards](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards). Chat apps can create cards with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). As part of the [Developer Preview Program](https://developers.google.com/workspace/preview), if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), it can create card messages. If your Chat app is not part of Developer Preview Program, it can't create cards with user authentication. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) { # A [card](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards) in a Google Chat message. Chat apps can create cards with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). As part of the [Developer Preview Program](https://developers.google.com/workspace/preview), if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), it can create card messages. If your Chat app is not part of Developer Preview Program, it can't create cards with user authentication. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) - "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. Any widgets beyond this limit are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A card. Maximum size is 32 KB. + "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. If a section's widgets push the total count above 100, that entire section and all following sections are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A card. Maximum size is 32 KB. "cardActions": [ # The card's actions. Actions are added to the card's toolbar menu. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): For example, the following JSON constructs a card action menu with `Settings` and `Send Feedback` options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ] ``` { # A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): "actionLabel": "A String", # The label that displays as the action menu item. @@ -21435,7 +21435,7 @@

Method Details

"A String", ], }, - "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. Any widgets beyond this limit are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A new card is pushed to the card stack after clicking if specified. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): + "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. If a section's widgets push the total count above 100, that entire section and all following sections are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A new card is pushed to the card stack after clicking if specified. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): "cardActions": [ # The card's actions. Actions are added to the card's toolbar menu. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): For example, the following JSON constructs a card action menu with `Settings` and `Send Feedback` options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ] ``` { # A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): "actionLabel": "A String", # The label that displays as the action menu item. @@ -22299,7 +22299,7 @@

Method Details

"userFacingMessage": "A String", # The message to send users about the status of their request. If unset, a generic message based on the `status_code` is sent. }, "dialog": { # Wrapper around the card body of the dialog. # Input only. [Dialog](https://developers.google.com/workspace/chat/dialogs) for the request. - "body": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. Any widgets beyond this limit are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # Input only. Body of the dialog, which is rendered in a modal. Google Chat apps don't support the following card entities: `DateTimePicker`, `OnChangeAction`. + "body": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. If a section's widgets push the total count above 100, that entire section and all following sections are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # Input only. Body of the dialog, which is rendered in a modal. Google Chat apps don't support the following card entities: `DateTimePicker`, `OnChangeAction`. "cardActions": [ # The card's actions. Actions are added to the card's toolbar menu. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): For example, the following JSON constructs a card action menu with `Settings` and `Send Feedback` options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ] ``` { # A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): "actionLabel": "A String", # The label that displays as the action menu item. @@ -23376,7 +23376,7 @@

Method Details

], "cardsV2": [ # Optional. An array of [cards](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards). Chat apps can create cards with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). As part of the [Developer Preview Program](https://developers.google.com/workspace/preview), if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), it can create card messages. If your Chat app is not part of Developer Preview Program, it can't create cards with user authentication. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) { # A [card](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards) in a Google Chat message. Chat apps can create cards with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). As part of the [Developer Preview Program](https://developers.google.com/workspace/preview), if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), it can create card messages. If your Chat app is not part of Developer Preview Program, it can't create cards with user authentication. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) - "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. Any widgets beyond this limit are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A card. Maximum size is 32 KB. + "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. If a section's widgets push the total count above 100, that entire section and all following sections are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A card. Maximum size is 32 KB. "cardActions": [ # The card's actions. Actions are added to the card's toolbar menu. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): For example, the following JSON constructs a card action menu with `Settings` and `Send Feedback` options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ] ``` { # A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): "actionLabel": "A String", # The label that displays as the action menu item. diff --git a/docs/dyn/chat_v1.spaces.spaceEvents.html b/docs/dyn/chat_v1.spaces.spaceEvents.html index a644dd8a47..01e2fefa6d 100644 --- a/docs/dyn/chat_v1.spaces.spaceEvents.html +++ b/docs/dyn/chat_v1.spaces.spaceEvents.html @@ -281,7 +281,7 @@

Method Details

"A String", ], }, - "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. Any widgets beyond this limit are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A new card is pushed to the card stack after clicking if specified. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): + "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. If a section's widgets push the total count above 100, that entire section and all following sections are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A new card is pushed to the card stack after clicking if specified. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): "cardActions": [ # The card's actions. Actions are added to the card's toolbar menu. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): For example, the following JSON constructs a card action menu with `Settings` and `Send Feedback` options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ] ``` { # A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): "actionLabel": "A String", # The label that displays as the action menu item. @@ -1145,7 +1145,7 @@

Method Details

"userFacingMessage": "A String", # The message to send users about the status of their request. If unset, a generic message based on the `status_code` is sent. }, "dialog": { # Wrapper around the card body of the dialog. # Input only. [Dialog](https://developers.google.com/workspace/chat/dialogs) for the request. - "body": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. Any widgets beyond this limit are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # Input only. Body of the dialog, which is rendered in a modal. Google Chat apps don't support the following card entities: `DateTimePicker`, `OnChangeAction`. + "body": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. If a section's widgets push the total count above 100, that entire section and all following sections are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # Input only. Body of the dialog, which is rendered in a modal. Google Chat apps don't support the following card entities: `DateTimePicker`, `OnChangeAction`. "cardActions": [ # The card's actions. Actions are added to the card's toolbar menu. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): For example, the following JSON constructs a card action menu with `Settings` and `Send Feedback` options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ] ``` { # A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): "actionLabel": "A String", # The label that displays as the action menu item. @@ -2222,7 +2222,7 @@

Method Details

], "cardsV2": [ # Optional. An array of [cards](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards). Chat apps can create cards with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). As part of the [Developer Preview Program](https://developers.google.com/workspace/preview), if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), it can create card messages. If your Chat app is not part of Developer Preview Program, it can't create cards with user authentication. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) { # A [card](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards) in a Google Chat message. Chat apps can create cards with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). As part of the [Developer Preview Program](https://developers.google.com/workspace/preview), if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), it can create card messages. If your Chat app is not part of Developer Preview Program, it can't create cards with user authentication. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) - "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. Any widgets beyond this limit are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A card. Maximum size is 32 KB. + "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. If a section's widgets push the total count above 100, that entire section and all following sections are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A card. Maximum size is 32 KB. "cardActions": [ # The card's actions. Actions are added to the card's toolbar menu. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): For example, the following JSON constructs a card action menu with `Settings` and `Send Feedback` options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ] ``` { # A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): "actionLabel": "A String", # The label that displays as the action menu item. @@ -3306,7 +3306,7 @@

Method Details

"A String", ], }, - "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. Any widgets beyond this limit are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A new card is pushed to the card stack after clicking if specified. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): + "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. If a section's widgets push the total count above 100, that entire section and all following sections are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A new card is pushed to the card stack after clicking if specified. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): "cardActions": [ # The card's actions. Actions are added to the card's toolbar menu. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): For example, the following JSON constructs a card action menu with `Settings` and `Send Feedback` options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ] ``` { # A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): "actionLabel": "A String", # The label that displays as the action menu item. @@ -4170,7 +4170,7 @@

Method Details

"userFacingMessage": "A String", # The message to send users about the status of their request. If unset, a generic message based on the `status_code` is sent. }, "dialog": { # Wrapper around the card body of the dialog. # Input only. [Dialog](https://developers.google.com/workspace/chat/dialogs) for the request. - "body": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. Any widgets beyond this limit are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # Input only. Body of the dialog, which is rendered in a modal. Google Chat apps don't support the following card entities: `DateTimePicker`, `OnChangeAction`. + "body": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. If a section's widgets push the total count above 100, that entire section and all following sections are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # Input only. Body of the dialog, which is rendered in a modal. Google Chat apps don't support the following card entities: `DateTimePicker`, `OnChangeAction`. "cardActions": [ # The card's actions. Actions are added to the card's toolbar menu. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): For example, the following JSON constructs a card action menu with `Settings` and `Send Feedback` options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ] ``` { # A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): "actionLabel": "A String", # The label that displays as the action menu item. @@ -5247,7 +5247,7 @@

Method Details

], "cardsV2": [ # Optional. An array of [cards](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards). Chat apps can create cards with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). As part of the [Developer Preview Program](https://developers.google.com/workspace/preview), if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), it can create card messages. If your Chat app is not part of Developer Preview Program, it can't create cards with user authentication. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) { # A [card](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards) in a Google Chat message. Chat apps can create cards with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). As part of the [Developer Preview Program](https://developers.google.com/workspace/preview), if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), it can create card messages. If your Chat app is not part of Developer Preview Program, it can't create cards with user authentication. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) - "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. Any widgets beyond this limit are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A card. Maximum size is 32 KB. + "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. If a section's widgets push the total count above 100, that entire section and all following sections are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A card. Maximum size is 32 KB. "cardActions": [ # The card's actions. Actions are added to the card's toolbar menu. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): For example, the following JSON constructs a card action menu with `Settings` and `Send Feedback` options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ] ``` { # A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): "actionLabel": "A String", # The label that displays as the action menu item. @@ -6331,7 +6331,7 @@

Method Details

"A String", ], }, - "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. Any widgets beyond this limit are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A new card is pushed to the card stack after clicking if specified. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): + "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. If a section's widgets push the total count above 100, that entire section and all following sections are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A new card is pushed to the card stack after clicking if specified. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): "cardActions": [ # The card's actions. Actions are added to the card's toolbar menu. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): For example, the following JSON constructs a card action menu with `Settings` and `Send Feedback` options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ] ``` { # A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): "actionLabel": "A String", # The label that displays as the action menu item. @@ -7195,7 +7195,7 @@

Method Details

"userFacingMessage": "A String", # The message to send users about the status of their request. If unset, a generic message based on the `status_code` is sent. }, "dialog": { # Wrapper around the card body of the dialog. # Input only. [Dialog](https://developers.google.com/workspace/chat/dialogs) for the request. - "body": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. Any widgets beyond this limit are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # Input only. Body of the dialog, which is rendered in a modal. Google Chat apps don't support the following card entities: `DateTimePicker`, `OnChangeAction`. + "body": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. If a section's widgets push the total count above 100, that entire section and all following sections are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # Input only. Body of the dialog, which is rendered in a modal. Google Chat apps don't support the following card entities: `DateTimePicker`, `OnChangeAction`. "cardActions": [ # The card's actions. Actions are added to the card's toolbar menu. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): For example, the following JSON constructs a card action menu with `Settings` and `Send Feedback` options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ] ``` { # A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): "actionLabel": "A String", # The label that displays as the action menu item. @@ -8272,7 +8272,7 @@

Method Details

], "cardsV2": [ # Optional. An array of [cards](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards). Chat apps can create cards with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). As part of the [Developer Preview Program](https://developers.google.com/workspace/preview), if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), it can create card messages. If your Chat app is not part of Developer Preview Program, it can't create cards with user authentication. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) { # A [card](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards) in a Google Chat message. Chat apps can create cards with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). As part of the [Developer Preview Program](https://developers.google.com/workspace/preview), if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), it can create card messages. If your Chat app is not part of Developer Preview Program, it can't create cards with user authentication. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) - "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. Any widgets beyond this limit are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A card. Maximum size is 32 KB. + "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. If a section's widgets push the total count above 100, that entire section and all following sections are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A card. Maximum size is 32 KB. "cardActions": [ # The card's actions. Actions are added to the card's toolbar menu. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): For example, the following JSON constructs a card action menu with `Settings` and `Send Feedback` options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ] ``` { # A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): "actionLabel": "A String", # The label that displays as the action menu item. @@ -9354,7 +9354,7 @@

Method Details

"A String", ], }, - "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. Any widgets beyond this limit are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A new card is pushed to the card stack after clicking if specified. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): + "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. If a section's widgets push the total count above 100, that entire section and all following sections are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A new card is pushed to the card stack after clicking if specified. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): "cardActions": [ # The card's actions. Actions are added to the card's toolbar menu. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): For example, the following JSON constructs a card action menu with `Settings` and `Send Feedback` options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ] ``` { # A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): "actionLabel": "A String", # The label that displays as the action menu item. @@ -10218,7 +10218,7 @@

Method Details

"userFacingMessage": "A String", # The message to send users about the status of their request. If unset, a generic message based on the `status_code` is sent. }, "dialog": { # Wrapper around the card body of the dialog. # Input only. [Dialog](https://developers.google.com/workspace/chat/dialogs) for the request. - "body": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. Any widgets beyond this limit are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # Input only. Body of the dialog, which is rendered in a modal. Google Chat apps don't support the following card entities: `DateTimePicker`, `OnChangeAction`. + "body": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. If a section's widgets push the total count above 100, that entire section and all following sections are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # Input only. Body of the dialog, which is rendered in a modal. Google Chat apps don't support the following card entities: `DateTimePicker`, `OnChangeAction`. "cardActions": [ # The card's actions. Actions are added to the card's toolbar menu. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): For example, the following JSON constructs a card action menu with `Settings` and `Send Feedback` options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ] ``` { # A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): "actionLabel": "A String", # The label that displays as the action menu item. @@ -11295,7 +11295,7 @@

Method Details

], "cardsV2": [ # Optional. An array of [cards](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards). Chat apps can create cards with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). As part of the [Developer Preview Program](https://developers.google.com/workspace/preview), if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), it can create card messages. If your Chat app is not part of Developer Preview Program, it can't create cards with user authentication. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) { # A [card](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards) in a Google Chat message. Chat apps can create cards with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). As part of the [Developer Preview Program](https://developers.google.com/workspace/preview), if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), it can create card messages. If your Chat app is not part of Developer Preview Program, it can't create cards with user authentication. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) - "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. Any widgets beyond this limit are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A card. Maximum size is 32 KB. + "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. If a section's widgets push the total count above 100, that entire section and all following sections are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A card. Maximum size is 32 KB. "cardActions": [ # The card's actions. Actions are added to the card's toolbar menu. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): For example, the following JSON constructs a card action menu with `Settings` and `Send Feedback` options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ] ``` { # A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): "actionLabel": "A String", # The label that displays as the action menu item. @@ -12375,7 +12375,7 @@

Method Details

"A String", ], }, - "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. Any widgets beyond this limit are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A new card is pushed to the card stack after clicking if specified. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): + "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. If a section's widgets push the total count above 100, that entire section and all following sections are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A new card is pushed to the card stack after clicking if specified. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): "cardActions": [ # The card's actions. Actions are added to the card's toolbar menu. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): For example, the following JSON constructs a card action menu with `Settings` and `Send Feedback` options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ] ``` { # A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): "actionLabel": "A String", # The label that displays as the action menu item. @@ -13239,7 +13239,7 @@

Method Details

"userFacingMessage": "A String", # The message to send users about the status of their request. If unset, a generic message based on the `status_code` is sent. }, "dialog": { # Wrapper around the card body of the dialog. # Input only. [Dialog](https://developers.google.com/workspace/chat/dialogs) for the request. - "body": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. Any widgets beyond this limit are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # Input only. Body of the dialog, which is rendered in a modal. Google Chat apps don't support the following card entities: `DateTimePicker`, `OnChangeAction`. + "body": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. If a section's widgets push the total count above 100, that entire section and all following sections are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # Input only. Body of the dialog, which is rendered in a modal. Google Chat apps don't support the following card entities: `DateTimePicker`, `OnChangeAction`. "cardActions": [ # The card's actions. Actions are added to the card's toolbar menu. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): For example, the following JSON constructs a card action menu with `Settings` and `Send Feedback` options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ] ``` { # A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): "actionLabel": "A String", # The label that displays as the action menu item. @@ -14316,7 +14316,7 @@

Method Details

], "cardsV2": [ # Optional. An array of [cards](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards). Chat apps can create cards with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). As part of the [Developer Preview Program](https://developers.google.com/workspace/preview), if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), it can create card messages. If your Chat app is not part of Developer Preview Program, it can't create cards with user authentication. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) { # A [card](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards) in a Google Chat message. Chat apps can create cards with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). As part of the [Developer Preview Program](https://developers.google.com/workspace/preview), if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), it can create card messages. If your Chat app is not part of Developer Preview Program, it can't create cards with user authentication. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) - "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. Any widgets beyond this limit are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A card. Maximum size is 32 KB. + "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. If a section's widgets push the total count above 100, that entire section and all following sections are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A card. Maximum size is 32 KB. "cardActions": [ # The card's actions. Actions are added to the card's toolbar menu. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): For example, the following JSON constructs a card action menu with `Settings` and `Send Feedback` options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ] ``` { # A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): "actionLabel": "A String", # The label that displays as the action menu item. @@ -15396,7 +15396,7 @@

Method Details

"A String", ], }, - "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. Any widgets beyond this limit are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A new card is pushed to the card stack after clicking if specified. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): + "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. If a section's widgets push the total count above 100, that entire section and all following sections are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A new card is pushed to the card stack after clicking if specified. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): "cardActions": [ # The card's actions. Actions are added to the card's toolbar menu. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): For example, the following JSON constructs a card action menu with `Settings` and `Send Feedback` options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ] ``` { # A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): "actionLabel": "A String", # The label that displays as the action menu item. @@ -16260,7 +16260,7 @@

Method Details

"userFacingMessage": "A String", # The message to send users about the status of their request. If unset, a generic message based on the `status_code` is sent. }, "dialog": { # Wrapper around the card body of the dialog. # Input only. [Dialog](https://developers.google.com/workspace/chat/dialogs) for the request. - "body": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. Any widgets beyond this limit are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # Input only. Body of the dialog, which is rendered in a modal. Google Chat apps don't support the following card entities: `DateTimePicker`, `OnChangeAction`. + "body": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. If a section's widgets push the total count above 100, that entire section and all following sections are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # Input only. Body of the dialog, which is rendered in a modal. Google Chat apps don't support the following card entities: `DateTimePicker`, `OnChangeAction`. "cardActions": [ # The card's actions. Actions are added to the card's toolbar menu. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): For example, the following JSON constructs a card action menu with `Settings` and `Send Feedback` options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ] ``` { # A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): "actionLabel": "A String", # The label that displays as the action menu item. @@ -17337,7 +17337,7 @@

Method Details

], "cardsV2": [ # Optional. An array of [cards](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards). Chat apps can create cards with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). As part of the [Developer Preview Program](https://developers.google.com/workspace/preview), if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), it can create card messages. If your Chat app is not part of Developer Preview Program, it can't create cards with user authentication. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) { # A [card](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards) in a Google Chat message. Chat apps can create cards with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). As part of the [Developer Preview Program](https://developers.google.com/workspace/preview), if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), it can create card messages. If your Chat app is not part of Developer Preview Program, it can't create cards with user authentication. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) - "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. Any widgets beyond this limit are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A card. Maximum size is 32 KB. + "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. If a section's widgets push the total count above 100, that entire section and all following sections are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A card. Maximum size is 32 KB. "cardActions": [ # The card's actions. Actions are added to the card's toolbar menu. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): For example, the following JSON constructs a card action menu with `Settings` and `Send Feedback` options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ] ``` { # A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): "actionLabel": "A String", # The label that displays as the action menu item. @@ -18834,7 +18834,7 @@

Method Details

"A String", ], }, - "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. Any widgets beyond this limit are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A new card is pushed to the card stack after clicking if specified. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): + "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. If a section's widgets push the total count above 100, that entire section and all following sections are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A new card is pushed to the card stack after clicking if specified. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): "cardActions": [ # The card's actions. Actions are added to the card's toolbar menu. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): For example, the following JSON constructs a card action menu with `Settings` and `Send Feedback` options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ] ``` { # A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): "actionLabel": "A String", # The label that displays as the action menu item. @@ -19698,7 +19698,7 @@

Method Details

"userFacingMessage": "A String", # The message to send users about the status of their request. If unset, a generic message based on the `status_code` is sent. }, "dialog": { # Wrapper around the card body of the dialog. # Input only. [Dialog](https://developers.google.com/workspace/chat/dialogs) for the request. - "body": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. Any widgets beyond this limit are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # Input only. Body of the dialog, which is rendered in a modal. Google Chat apps don't support the following card entities: `DateTimePicker`, `OnChangeAction`. + "body": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. If a section's widgets push the total count above 100, that entire section and all following sections are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # Input only. Body of the dialog, which is rendered in a modal. Google Chat apps don't support the following card entities: `DateTimePicker`, `OnChangeAction`. "cardActions": [ # The card's actions. Actions are added to the card's toolbar menu. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): For example, the following JSON constructs a card action menu with `Settings` and `Send Feedback` options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ] ``` { # A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): "actionLabel": "A String", # The label that displays as the action menu item. @@ -20775,7 +20775,7 @@

Method Details

], "cardsV2": [ # Optional. An array of [cards](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards). Chat apps can create cards with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). As part of the [Developer Preview Program](https://developers.google.com/workspace/preview), if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), it can create card messages. If your Chat app is not part of Developer Preview Program, it can't create cards with user authentication. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) { # A [card](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards) in a Google Chat message. Chat apps can create cards with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). As part of the [Developer Preview Program](https://developers.google.com/workspace/preview), if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), it can create card messages. If your Chat app is not part of Developer Preview Program, it can't create cards with user authentication. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) - "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. Any widgets beyond this limit are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A card. Maximum size is 32 KB. + "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. If a section's widgets push the total count above 100, that entire section and all following sections are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A card. Maximum size is 32 KB. "cardActions": [ # The card's actions. Actions are added to the card's toolbar menu. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): For example, the following JSON constructs a card action menu with `Settings` and `Send Feedback` options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ] ``` { # A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): "actionLabel": "A String", # The label that displays as the action menu item. @@ -21859,7 +21859,7 @@

Method Details

"A String", ], }, - "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. Any widgets beyond this limit are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A new card is pushed to the card stack after clicking if specified. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): + "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. If a section's widgets push the total count above 100, that entire section and all following sections are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A new card is pushed to the card stack after clicking if specified. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): "cardActions": [ # The card's actions. Actions are added to the card's toolbar menu. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): For example, the following JSON constructs a card action menu with `Settings` and `Send Feedback` options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ] ``` { # A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): "actionLabel": "A String", # The label that displays as the action menu item. @@ -22723,7 +22723,7 @@

Method Details

"userFacingMessage": "A String", # The message to send users about the status of their request. If unset, a generic message based on the `status_code` is sent. }, "dialog": { # Wrapper around the card body of the dialog. # Input only. [Dialog](https://developers.google.com/workspace/chat/dialogs) for the request. - "body": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. Any widgets beyond this limit are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # Input only. Body of the dialog, which is rendered in a modal. Google Chat apps don't support the following card entities: `DateTimePicker`, `OnChangeAction`. + "body": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. If a section's widgets push the total count above 100, that entire section and all following sections are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # Input only. Body of the dialog, which is rendered in a modal. Google Chat apps don't support the following card entities: `DateTimePicker`, `OnChangeAction`. "cardActions": [ # The card's actions. Actions are added to the card's toolbar menu. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): For example, the following JSON constructs a card action menu with `Settings` and `Send Feedback` options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ] ``` { # A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): "actionLabel": "A String", # The label that displays as the action menu item. @@ -23800,7 +23800,7 @@

Method Details

], "cardsV2": [ # Optional. An array of [cards](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards). Chat apps can create cards with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). As part of the [Developer Preview Program](https://developers.google.com/workspace/preview), if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), it can create card messages. If your Chat app is not part of Developer Preview Program, it can't create cards with user authentication. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) { # A [card](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards) in a Google Chat message. Chat apps can create cards with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). As part of the [Developer Preview Program](https://developers.google.com/workspace/preview), if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), it can create card messages. If your Chat app is not part of Developer Preview Program, it can't create cards with user authentication. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) - "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. Any widgets beyond this limit are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A card. Maximum size is 32 KB. + "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. If a section's widgets push the total count above 100, that entire section and all following sections are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A card. Maximum size is 32 KB. "cardActions": [ # The card's actions. Actions are added to the card's toolbar menu. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): For example, the following JSON constructs a card action menu with `Settings` and `Send Feedback` options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ] ``` { # A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): "actionLabel": "A String", # The label that displays as the action menu item. @@ -24884,7 +24884,7 @@

Method Details

"A String", ], }, - "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. Any widgets beyond this limit are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A new card is pushed to the card stack after clicking if specified. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): + "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. If a section's widgets push the total count above 100, that entire section and all following sections are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A new card is pushed to the card stack after clicking if specified. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): "cardActions": [ # The card's actions. Actions are added to the card's toolbar menu. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): For example, the following JSON constructs a card action menu with `Settings` and `Send Feedback` options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ] ``` { # A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): "actionLabel": "A String", # The label that displays as the action menu item. @@ -25748,7 +25748,7 @@

Method Details

"userFacingMessage": "A String", # The message to send users about the status of their request. If unset, a generic message based on the `status_code` is sent. }, "dialog": { # Wrapper around the card body of the dialog. # Input only. [Dialog](https://developers.google.com/workspace/chat/dialogs) for the request. - "body": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. Any widgets beyond this limit are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # Input only. Body of the dialog, which is rendered in a modal. Google Chat apps don't support the following card entities: `DateTimePicker`, `OnChangeAction`. + "body": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. If a section's widgets push the total count above 100, that entire section and all following sections are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # Input only. Body of the dialog, which is rendered in a modal. Google Chat apps don't support the following card entities: `DateTimePicker`, `OnChangeAction`. "cardActions": [ # The card's actions. Actions are added to the card's toolbar menu. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): For example, the following JSON constructs a card action menu with `Settings` and `Send Feedback` options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ] ``` { # A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): "actionLabel": "A String", # The label that displays as the action menu item. @@ -26825,7 +26825,7 @@

Method Details

], "cardsV2": [ # Optional. An array of [cards](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards). Chat apps can create cards with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). As part of the [Developer Preview Program](https://developers.google.com/workspace/preview), if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), it can create card messages. If your Chat app is not part of Developer Preview Program, it can't create cards with user authentication. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) { # A [card](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards) in a Google Chat message. Chat apps can create cards with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). As part of the [Developer Preview Program](https://developers.google.com/workspace/preview), if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), it can create card messages. If your Chat app is not part of Developer Preview Program, it can't create cards with user authentication. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) - "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. Any widgets beyond this limit are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A card. Maximum size is 32 KB. + "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. If a section's widgets push the total count above 100, that entire section and all following sections are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A card. Maximum size is 32 KB. "cardActions": [ # The card's actions. Actions are added to the card's toolbar menu. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): For example, the following JSON constructs a card action menu with `Settings` and `Send Feedback` options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ] ``` { # A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): "actionLabel": "A String", # The label that displays as the action menu item. @@ -27907,7 +27907,7 @@

Method Details

"A String", ], }, - "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. Any widgets beyond this limit are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A new card is pushed to the card stack after clicking if specified. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): + "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. If a section's widgets push the total count above 100, that entire section and all following sections are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A new card is pushed to the card stack after clicking if specified. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): "cardActions": [ # The card's actions. Actions are added to the card's toolbar menu. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): For example, the following JSON constructs a card action menu with `Settings` and `Send Feedback` options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ] ``` { # A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): "actionLabel": "A String", # The label that displays as the action menu item. @@ -28771,7 +28771,7 @@

Method Details

"userFacingMessage": "A String", # The message to send users about the status of their request. If unset, a generic message based on the `status_code` is sent. }, "dialog": { # Wrapper around the card body of the dialog. # Input only. [Dialog](https://developers.google.com/workspace/chat/dialogs) for the request. - "body": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. Any widgets beyond this limit are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # Input only. Body of the dialog, which is rendered in a modal. Google Chat apps don't support the following card entities: `DateTimePicker`, `OnChangeAction`. + "body": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. If a section's widgets push the total count above 100, that entire section and all following sections are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # Input only. Body of the dialog, which is rendered in a modal. Google Chat apps don't support the following card entities: `DateTimePicker`, `OnChangeAction`. "cardActions": [ # The card's actions. Actions are added to the card's toolbar menu. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): For example, the following JSON constructs a card action menu with `Settings` and `Send Feedback` options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ] ``` { # A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): "actionLabel": "A String", # The label that displays as the action menu item. @@ -29848,7 +29848,7 @@

Method Details

], "cardsV2": [ # Optional. An array of [cards](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards). Chat apps can create cards with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). As part of the [Developer Preview Program](https://developers.google.com/workspace/preview), if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), it can create card messages. If your Chat app is not part of Developer Preview Program, it can't create cards with user authentication. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) { # A [card](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards) in a Google Chat message. Chat apps can create cards with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). As part of the [Developer Preview Program](https://developers.google.com/workspace/preview), if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), it can create card messages. If your Chat app is not part of Developer Preview Program, it can't create cards with user authentication. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) - "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. Any widgets beyond this limit are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A card. Maximum size is 32 KB. + "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. If a section's widgets push the total count above 100, that entire section and all following sections are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A card. Maximum size is 32 KB. "cardActions": [ # The card's actions. Actions are added to the card's toolbar menu. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): For example, the following JSON constructs a card action menu with `Settings` and `Send Feedback` options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ] ``` { # A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): "actionLabel": "A String", # The label that displays as the action menu item. @@ -30928,7 +30928,7 @@

Method Details

"A String", ], }, - "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. Any widgets beyond this limit are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A new card is pushed to the card stack after clicking if specified. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): + "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. If a section's widgets push the total count above 100, that entire section and all following sections are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A new card is pushed to the card stack after clicking if specified. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): "cardActions": [ # The card's actions. Actions are added to the card's toolbar menu. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): For example, the following JSON constructs a card action menu with `Settings` and `Send Feedback` options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ] ``` { # A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): "actionLabel": "A String", # The label that displays as the action menu item. @@ -31792,7 +31792,7 @@

Method Details

"userFacingMessage": "A String", # The message to send users about the status of their request. If unset, a generic message based on the `status_code` is sent. }, "dialog": { # Wrapper around the card body of the dialog. # Input only. [Dialog](https://developers.google.com/workspace/chat/dialogs) for the request. - "body": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. Any widgets beyond this limit are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # Input only. Body of the dialog, which is rendered in a modal. Google Chat apps don't support the following card entities: `DateTimePicker`, `OnChangeAction`. + "body": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. If a section's widgets push the total count above 100, that entire section and all following sections are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # Input only. Body of the dialog, which is rendered in a modal. Google Chat apps don't support the following card entities: `DateTimePicker`, `OnChangeAction`. "cardActions": [ # The card's actions. Actions are added to the card's toolbar menu. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): For example, the following JSON constructs a card action menu with `Settings` and `Send Feedback` options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ] ``` { # A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): "actionLabel": "A String", # The label that displays as the action menu item. @@ -32869,7 +32869,7 @@

Method Details

], "cardsV2": [ # Optional. An array of [cards](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards). Chat apps can create cards with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). As part of the [Developer Preview Program](https://developers.google.com/workspace/preview), if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), it can create card messages. If your Chat app is not part of Developer Preview Program, it can't create cards with user authentication. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) { # A [card](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards) in a Google Chat message. Chat apps can create cards with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). As part of the [Developer Preview Program](https://developers.google.com/workspace/preview), if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), it can create card messages. If your Chat app is not part of Developer Preview Program, it can't create cards with user authentication. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) - "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. Any widgets beyond this limit are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A card. Maximum size is 32 KB. + "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. If a section's widgets push the total count above 100, that entire section and all following sections are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A card. Maximum size is 32 KB. "cardActions": [ # The card's actions. Actions are added to the card's toolbar menu. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): For example, the following JSON constructs a card action menu with `Settings` and `Send Feedback` options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ] ``` { # A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): "actionLabel": "A String", # The label that displays as the action menu item. @@ -33949,7 +33949,7 @@

Method Details

"A String", ], }, - "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. Any widgets beyond this limit are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A new card is pushed to the card stack after clicking if specified. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): + "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. If a section's widgets push the total count above 100, that entire section and all following sections are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A new card is pushed to the card stack after clicking if specified. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): "cardActions": [ # The card's actions. Actions are added to the card's toolbar menu. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): For example, the following JSON constructs a card action menu with `Settings` and `Send Feedback` options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ] ``` { # A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): "actionLabel": "A String", # The label that displays as the action menu item. @@ -34813,7 +34813,7 @@

Method Details

"userFacingMessage": "A String", # The message to send users about the status of their request. If unset, a generic message based on the `status_code` is sent. }, "dialog": { # Wrapper around the card body of the dialog. # Input only. [Dialog](https://developers.google.com/workspace/chat/dialogs) for the request. - "body": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. Any widgets beyond this limit are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # Input only. Body of the dialog, which is rendered in a modal. Google Chat apps don't support the following card entities: `DateTimePicker`, `OnChangeAction`. + "body": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. If a section's widgets push the total count above 100, that entire section and all following sections are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # Input only. Body of the dialog, which is rendered in a modal. Google Chat apps don't support the following card entities: `DateTimePicker`, `OnChangeAction`. "cardActions": [ # The card's actions. Actions are added to the card's toolbar menu. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): For example, the following JSON constructs a card action menu with `Settings` and `Send Feedback` options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ] ``` { # A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): "actionLabel": "A String", # The label that displays as the action menu item. @@ -35890,7 +35890,7 @@

Method Details

], "cardsV2": [ # Optional. An array of [cards](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards). Chat apps can create cards with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). As part of the [Developer Preview Program](https://developers.google.com/workspace/preview), if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), it can create card messages. If your Chat app is not part of Developer Preview Program, it can't create cards with user authentication. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) { # A [card](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards) in a Google Chat message. Chat apps can create cards with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). As part of the [Developer Preview Program](https://developers.google.com/workspace/preview), if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), it can create card messages. If your Chat app is not part of Developer Preview Program, it can't create cards with user authentication. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) - "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. Any widgets beyond this limit are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A card. Maximum size is 32 KB. + "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. If a section's widgets push the total count above 100, that entire section and all following sections are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A card. Maximum size is 32 KB. "cardActions": [ # The card's actions. Actions are added to the card's toolbar menu. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): For example, the following JSON constructs a card action menu with `Settings` and `Send Feedback` options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ] ``` { # A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): "actionLabel": "A String", # The label that displays as the action menu item. diff --git a/docs/dyn/clouddeploy_v1.projects.locations.html b/docs/dyn/clouddeploy_v1.projects.locations.html index 34bb0ad3aa..2a99f0e66f 100644 --- a/docs/dyn/clouddeploy_v1.projects.locations.html +++ b/docs/dyn/clouddeploy_v1.projects.locations.html @@ -110,7 +110,7 @@

Instance Methods

Gets the configuration for a location.

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

-

Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.

+

Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.

list_next()

Retrieves the next page of results.

@@ -189,7 +189,7 @@

Method Details

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
+  
Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
diff --git a/docs/dyn/cloudlocationfinder_v1.projects.locations.html b/docs/dyn/cloudlocationfinder_v1.projects.locations.html
index 03d080de95..4fd6816487 100644
--- a/docs/dyn/cloudlocationfinder_v1.projects.locations.html
+++ b/docs/dyn/cloudlocationfinder_v1.projects.locations.html
@@ -87,7 +87,7 @@ 

Instance Methods

Gets information about a location.

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

-

Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.

+

Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.

list_next()

Retrieves the next page of results.

@@ -126,7 +126,7 @@

Method Details

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
+  
Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
diff --git a/docs/dyn/cloudlocationfinder_v1alpha.projects.locations.html b/docs/dyn/cloudlocationfinder_v1alpha.projects.locations.html
index 20843fc790..d7603d4039 100644
--- a/docs/dyn/cloudlocationfinder_v1alpha.projects.locations.html
+++ b/docs/dyn/cloudlocationfinder_v1alpha.projects.locations.html
@@ -87,7 +87,7 @@ 

Instance Methods

Gets information about a location.

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

-

Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.

+

Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.

list_next()

Retrieves the next page of results.

@@ -126,7 +126,7 @@

Method Details

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
+  
Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
diff --git a/docs/dyn/cloudtasks_v2.projects.locations.html b/docs/dyn/cloudtasks_v2.projects.locations.html
index e2d835eaeb..c4fdfc7068 100644
--- a/docs/dyn/cloudtasks_v2.projects.locations.html
+++ b/docs/dyn/cloudtasks_v2.projects.locations.html
@@ -90,7 +90,7 @@ 

Instance Methods

Gets the CMEK config. Gets the Customer Managed Encryption Key configured with the Cloud Tasks lcoation. By default there is no kms_key configured.

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

-

Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.

+

Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.

list_next()

Retrieves the next page of results.

@@ -152,7 +152,7 @@

Method Details

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
+  
Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
diff --git a/docs/dyn/cloudtasks_v2beta2.projects.locations.html b/docs/dyn/cloudtasks_v2beta2.projects.locations.html
index 7fcfb1eb19..25deefc49b 100644
--- a/docs/dyn/cloudtasks_v2beta2.projects.locations.html
+++ b/docs/dyn/cloudtasks_v2beta2.projects.locations.html
@@ -74,6 +74,11 @@
 
 

Cloud Tasks API . projects . locations

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+

queues()

@@ -90,7 +95,7 @@

Instance Methods

Gets the CMEK config. Gets the Customer Managed Encryption Key configured with the Cloud Tasks lcoation. By default there is no kms_key configured.

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

-

Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.

+

Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.

list_next()

Retrieves the next page of results.

@@ -152,7 +157,7 @@

Method Details

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
+  
Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
diff --git a/docs/dyn/cloudtasks_v2beta2.projects.locations.operations.html b/docs/dyn/cloudtasks_v2beta2.projects.locations.operations.html
new file mode 100644
index 0000000000..9b75a5fc74
--- /dev/null
+++ b/docs/dyn/cloudtasks_v2beta2.projects.locations.operations.html
@@ -0,0 +1,124 @@
+
+
+
+

Cloud Tasks API . projects . locations . operations

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) +
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  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, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/cloudtasks_v2beta3.projects.locations.html b/docs/dyn/cloudtasks_v2beta3.projects.locations.html index 470d79a842..34aacdfa1c 100644 --- a/docs/dyn/cloudtasks_v2beta3.projects.locations.html +++ b/docs/dyn/cloudtasks_v2beta3.projects.locations.html @@ -90,7 +90,7 @@

Instance Methods

Gets the CMEK config. Gets the Customer Managed Encryption Key configured with the Cloud Tasks lcoation. By default there is no kms_key configured.

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

-

Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.

+

Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.

list_next()

Retrieves the next page of results.

@@ -152,7 +152,7 @@

Method Details

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
+  
Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
diff --git a/docs/dyn/compute_alpha.disks.html b/docs/dyn/compute_alpha.disks.html
index e16daf030f..b686b8d897 100644
--- a/docs/dyn/compute_alpha.disks.html
+++ b/docs/dyn/compute_alpha.disks.html
@@ -1287,7 +1287,8 @@ 

Method Details

# - projects/project/zones/zone/instantSnapshotGroups/instantSnapshotGroup # - zones/zone/instantSnapshotGroups/instantSnapshotGroup }, - "snapshotGroupParameters": { # The parameters for the snapshot group. + "snapshotGroupParameters": { # The parameters for the snapshot group. The usage of snapshot group feature + # is restricted. "replicaZones": [ # URLs of the zones where disks should be replicated to. Only applicable # for regional resources. "A String", @@ -2425,8 +2426,9 @@

Method Details

# encryption key that protects this resource. }, "snapshotGroupId": "A String", # Output only. [Output Only] The unique ID of the snapshot group that this snapshot - # belongs to. - "snapshotGroupName": "A String", # Output only. [Output only] The snapshot group that this snapshot belongs to. + # belongs to. The usage of snapshot group feature is restricted. + "snapshotGroupName": "A String", # Output only. [Output only] The snapshot group that this snapshot belongs to. The usage + # of snapshot group feature is restricted. "snapshotType": "A String", # Indicates the type of the snapshot. "sourceDisk": "A String", # The source disk used to create this snapshot. "sourceDiskEncryptionKey": { # The customer-supplied diff --git a/docs/dyn/compute_alpha.recoverableSnapshots.html b/docs/dyn/compute_alpha.recoverableSnapshots.html index f0411dc8b5..4fa18cf3a5 100644 --- a/docs/dyn/compute_alpha.recoverableSnapshots.html +++ b/docs/dyn/compute_alpha.recoverableSnapshots.html @@ -393,8 +393,9 @@

Method Details

# encryption key that protects this resource. }, "snapshotGroupId": "A String", # Output only. [Output Only] The unique ID of the snapshot group that this snapshot - # belongs to. - "snapshotGroupName": "A String", # Output only. [Output only] The snapshot group that this snapshot belongs to. + # belongs to. The usage of snapshot group feature is restricted. + "snapshotGroupName": "A String", # Output only. [Output only] The snapshot group that this snapshot belongs to. The usage + # of snapshot group feature is restricted. "snapshotType": "A String", # Indicates the type of the snapshot. "sourceDisk": "A String", # The source disk used to create this snapshot. "sourceDiskEncryptionKey": { # The customer-supplied @@ -1106,8 +1107,9 @@

Method Details

# encryption key that protects this resource. }, "snapshotGroupId": "A String", # Output only. [Output Only] The unique ID of the snapshot group that this snapshot - # belongs to. - "snapshotGroupName": "A String", # Output only. [Output only] The snapshot group that this snapshot belongs to. + # belongs to. The usage of snapshot group feature is restricted. + "snapshotGroupName": "A String", # Output only. [Output only] The snapshot group that this snapshot belongs to. The usage + # of snapshot group feature is restricted. "snapshotType": "A String", # Indicates the type of the snapshot. "sourceDisk": "A String", # The source disk used to create this snapshot. "sourceDiskEncryptionKey": { # The customer-supplied @@ -1892,8 +1894,9 @@

Method Details

# encryption key that protects this resource. }, "snapshotGroupId": "A String", # Output only. [Output Only] The unique ID of the snapshot group that this snapshot - # belongs to. - "snapshotGroupName": "A String", # Output only. [Output only] The snapshot group that this snapshot belongs to. + # belongs to. The usage of snapshot group feature is restricted. + "snapshotGroupName": "A String", # Output only. [Output only] The snapshot group that this snapshot belongs to. The usage + # of snapshot group feature is restricted. "snapshotType": "A String", # Indicates the type of the snapshot. "sourceDisk": "A String", # The source disk used to create this snapshot. "sourceDiskEncryptionKey": { # The customer-supplied diff --git a/docs/dyn/compute_alpha.regionDisks.html b/docs/dyn/compute_alpha.regionDisks.html index 881016fe79..0d26536565 100644 --- a/docs/dyn/compute_alpha.regionDisks.html +++ b/docs/dyn/compute_alpha.regionDisks.html @@ -469,7 +469,8 @@

Method Details

# - projects/project/zones/zone/instantSnapshotGroups/instantSnapshotGroup # - zones/zone/instantSnapshotGroups/instantSnapshotGroup }, - "snapshotGroupParameters": { # The parameters for the snapshot group. + "snapshotGroupParameters": { # The parameters for the snapshot group. The usage of snapshot group feature + # is restricted. "replicaZones": [ # URLs of the zones where disks should be replicated to. Only applicable # for regional resources. "A String", @@ -985,8 +986,9 @@

Method Details

# encryption key that protects this resource. }, "snapshotGroupId": "A String", # Output only. [Output Only] The unique ID of the snapshot group that this snapshot - # belongs to. - "snapshotGroupName": "A String", # Output only. [Output only] The snapshot group that this snapshot belongs to. + # belongs to. The usage of snapshot group feature is restricted. + "snapshotGroupName": "A String", # Output only. [Output only] The snapshot group that this snapshot belongs to. The usage + # of snapshot group feature is restricted. "snapshotType": "A String", # Indicates the type of the snapshot. "sourceDisk": "A String", # The source disk used to create this snapshot. "sourceDiskEncryptionKey": { # The customer-supplied diff --git a/docs/dyn/compute_alpha.regionRecoverableSnapshots.html b/docs/dyn/compute_alpha.regionRecoverableSnapshots.html index d94df8fe0f..bebacc121c 100644 --- a/docs/dyn/compute_alpha.regionRecoverableSnapshots.html +++ b/docs/dyn/compute_alpha.regionRecoverableSnapshots.html @@ -589,8 +589,9 @@

Method Details

# encryption key that protects this resource. }, "snapshotGroupId": "A String", # Output only. [Output Only] The unique ID of the snapshot group that this snapshot - # belongs to. - "snapshotGroupName": "A String", # Output only. [Output only] The snapshot group that this snapshot belongs to. + # belongs to. The usage of snapshot group feature is restricted. + "snapshotGroupName": "A String", # Output only. [Output only] The snapshot group that this snapshot belongs to. The usage + # of snapshot group feature is restricted. "snapshotType": "A String", # Indicates the type of the snapshot. "sourceDisk": "A String", # The source disk used to create this snapshot. "sourceDiskEncryptionKey": { # The customer-supplied @@ -1378,8 +1379,9 @@

Method Details

# encryption key that protects this resource. }, "snapshotGroupId": "A String", # Output only. [Output Only] The unique ID of the snapshot group that this snapshot - # belongs to. - "snapshotGroupName": "A String", # Output only. [Output only] The snapshot group that this snapshot belongs to. + # belongs to. The usage of snapshot group feature is restricted. + "snapshotGroupName": "A String", # Output only. [Output only] The snapshot group that this snapshot belongs to. The usage + # of snapshot group feature is restricted. "snapshotType": "A String", # Indicates the type of the snapshot. "sourceDisk": "A String", # The source disk used to create this snapshot. "sourceDiskEncryptionKey": { # The customer-supplied diff --git a/docs/dyn/compute_alpha.regionSnapshots.html b/docs/dyn/compute_alpha.regionSnapshots.html index 041d688cbb..2bb902211f 100644 --- a/docs/dyn/compute_alpha.regionSnapshots.html +++ b/docs/dyn/compute_alpha.regionSnapshots.html @@ -610,8 +610,9 @@

Method Details

# encryption key that protects this resource. }, "snapshotGroupId": "A String", # Output only. [Output Only] The unique ID of the snapshot group that this snapshot - # belongs to. - "snapshotGroupName": "A String", # Output only. [Output only] The snapshot group that this snapshot belongs to. + # belongs to. The usage of snapshot group feature is restricted. + "snapshotGroupName": "A String", # Output only. [Output only] The snapshot group that this snapshot belongs to. The usage + # of snapshot group feature is restricted. "snapshotType": "A String", # Indicates the type of the snapshot. "sourceDisk": "A String", # The source disk used to create this snapshot. "sourceDiskEncryptionKey": { # The customer-supplied @@ -1320,8 +1321,9 @@

Method Details

# encryption key that protects this resource. }, "snapshotGroupId": "A String", # Output only. [Output Only] The unique ID of the snapshot group that this snapshot - # belongs to. - "snapshotGroupName": "A String", # Output only. [Output only] The snapshot group that this snapshot belongs to. + # belongs to. The usage of snapshot group feature is restricted. + "snapshotGroupName": "A String", # Output only. [Output only] The snapshot group that this snapshot belongs to. The usage + # of snapshot group feature is restricted. "snapshotType": "A String", # Indicates the type of the snapshot. "sourceDisk": "A String", # The source disk used to create this snapshot. "sourceDiskEncryptionKey": { # The customer-supplied @@ -2037,8 +2039,9 @@

Method Details

# encryption key that protects this resource. }, "snapshotGroupId": "A String", # Output only. [Output Only] The unique ID of the snapshot group that this snapshot - # belongs to. - "snapshotGroupName": "A String", # Output only. [Output only] The snapshot group that this snapshot belongs to. + # belongs to. The usage of snapshot group feature is restricted. + "snapshotGroupName": "A String", # Output only. [Output only] The snapshot group that this snapshot belongs to. The usage + # of snapshot group feature is restricted. "snapshotType": "A String", # Indicates the type of the snapshot. "sourceDisk": "A String", # The source disk used to create this snapshot. "sourceDiskEncryptionKey": { # The customer-supplied diff --git a/docs/dyn/compute_alpha.snapshots.html b/docs/dyn/compute_alpha.snapshots.html index e41280a6a4..57f538c54c 100644 --- a/docs/dyn/compute_alpha.snapshots.html +++ b/docs/dyn/compute_alpha.snapshots.html @@ -413,8 +413,9 @@

Method Details

# encryption key that protects this resource. }, "snapshotGroupId": "A String", # Output only. [Output Only] The unique ID of the snapshot group that this snapshot - # belongs to. - "snapshotGroupName": "A String", # Output only. [Output only] The snapshot group that this snapshot belongs to. + # belongs to. The usage of snapshot group feature is restricted. + "snapshotGroupName": "A String", # Output only. [Output only] The snapshot group that this snapshot belongs to. The usage + # of snapshot group feature is restricted. "snapshotType": "A String", # Indicates the type of the snapshot. "sourceDisk": "A String", # The source disk used to create this snapshot. "sourceDiskEncryptionKey": { # The customer-supplied @@ -1143,8 +1144,9 @@

Method Details

# encryption key that protects this resource. }, "snapshotGroupId": "A String", # Output only. [Output Only] The unique ID of the snapshot group that this snapshot - # belongs to. - "snapshotGroupName": "A String", # Output only. [Output only] The snapshot group that this snapshot belongs to. + # belongs to. The usage of snapshot group feature is restricted. + "snapshotGroupName": "A String", # Output only. [Output only] The snapshot group that this snapshot belongs to. The usage + # of snapshot group feature is restricted. "snapshotType": "A String", # Indicates the type of the snapshot. "sourceDisk": "A String", # The source disk used to create this snapshot. "sourceDiskEncryptionKey": { # The customer-supplied @@ -1876,8 +1878,9 @@

Method Details

# encryption key that protects this resource. }, "snapshotGroupId": "A String", # Output only. [Output Only] The unique ID of the snapshot group that this snapshot - # belongs to. - "snapshotGroupName": "A String", # Output only. [Output only] The snapshot group that this snapshot belongs to. + # belongs to. The usage of snapshot group feature is restricted. + "snapshotGroupName": "A String", # Output only. [Output only] The snapshot group that this snapshot belongs to. The usage + # of snapshot group feature is restricted. "snapshotType": "A String", # Indicates the type of the snapshot. "sourceDisk": "A String", # The source disk used to create this snapshot. "sourceDiskEncryptionKey": { # The customer-supplied @@ -2592,8 +2595,9 @@

Method Details

# encryption key that protects this resource. }, "snapshotGroupId": "A String", # Output only. [Output Only] The unique ID of the snapshot group that this snapshot - # belongs to. - "snapshotGroupName": "A String", # Output only. [Output only] The snapshot group that this snapshot belongs to. + # belongs to. The usage of snapshot group feature is restricted. + "snapshotGroupName": "A String", # Output only. [Output only] The snapshot group that this snapshot belongs to. The usage + # of snapshot group feature is restricted. "snapshotType": "A String", # Indicates the type of the snapshot. "sourceDisk": "A String", # The source disk used to create this snapshot. "sourceDiskEncryptionKey": { # The customer-supplied diff --git a/docs/dyn/compute_beta.disks.html b/docs/dyn/compute_beta.disks.html index f23e296f9d..ebb8c876d5 100644 --- a/docs/dyn/compute_beta.disks.html +++ b/docs/dyn/compute_beta.disks.html @@ -1204,7 +1204,8 @@

Method Details

# - projects/project/zones/zone/instantSnapshotGroups/instantSnapshotGroup # - zones/zone/instantSnapshotGroups/instantSnapshotGroup }, - "snapshotGroupParameters": { # The parameters for the snapshot group. + "snapshotGroupParameters": { # The parameters for the snapshot group. The usage of snapshot group feature + # is restricted. "replicaZones": [ # URLs of the zones where disks should be replicated to. Only applicable # for regional resources. "A String", @@ -2025,8 +2026,9 @@

Method Details

# encryption key that protects this resource. }, "snapshotGroupId": "A String", # Output only. [Output Only] The unique ID of the snapshot group that this snapshot - # belongs to. - "snapshotGroupName": "A String", # Output only. [Output only] The snapshot group that this snapshot belongs to. + # belongs to. The usage of snapshot group feature is restricted. + "snapshotGroupName": "A String", # Output only. [Output only] The snapshot group that this snapshot belongs to. The usage + # of snapshot group feature is restricted. "snapshotType": "A String", # Indicates the type of the snapshot. "sourceDisk": "A String", # The source disk used to create this snapshot. "sourceDiskEncryptionKey": { # The customer-supplied diff --git a/docs/dyn/compute_beta.regionDisks.html b/docs/dyn/compute_beta.regionDisks.html index 4ea42ba5ab..3d7d671e1e 100644 --- a/docs/dyn/compute_beta.regionDisks.html +++ b/docs/dyn/compute_beta.regionDisks.html @@ -462,7 +462,8 @@

Method Details

# - projects/project/zones/zone/instantSnapshotGroups/instantSnapshotGroup # - zones/zone/instantSnapshotGroups/instantSnapshotGroup }, - "snapshotGroupParameters": { # The parameters for the snapshot group. + "snapshotGroupParameters": { # The parameters for the snapshot group. The usage of snapshot group feature + # is restricted. "replicaZones": [ # URLs of the zones where disks should be replicated to. Only applicable # for regional resources. "A String", @@ -970,8 +971,9 @@

Method Details

# encryption key that protects this resource. }, "snapshotGroupId": "A String", # Output only. [Output Only] The unique ID of the snapshot group that this snapshot - # belongs to. - "snapshotGroupName": "A String", # Output only. [Output only] The snapshot group that this snapshot belongs to. + # belongs to. The usage of snapshot group feature is restricted. + "snapshotGroupName": "A String", # Output only. [Output only] The snapshot group that this snapshot belongs to. The usage + # of snapshot group feature is restricted. "snapshotType": "A String", # Indicates the type of the snapshot. "sourceDisk": "A String", # The source disk used to create this snapshot. "sourceDiskEncryptionKey": { # The customer-supplied diff --git a/docs/dyn/compute_beta.regionSnapshots.html b/docs/dyn/compute_beta.regionSnapshots.html index 5b511a21f5..466bb01479 100644 --- a/docs/dyn/compute_beta.regionSnapshots.html +++ b/docs/dyn/compute_beta.regionSnapshots.html @@ -602,8 +602,9 @@

Method Details

# encryption key that protects this resource. }, "snapshotGroupId": "A String", # Output only. [Output Only] The unique ID of the snapshot group that this snapshot - # belongs to. - "snapshotGroupName": "A String", # Output only. [Output only] The snapshot group that this snapshot belongs to. + # belongs to. The usage of snapshot group feature is restricted. + "snapshotGroupName": "A String", # Output only. [Output only] The snapshot group that this snapshot belongs to. The usage + # of snapshot group feature is restricted. "snapshotType": "A String", # Indicates the type of the snapshot. "sourceDisk": "A String", # The source disk used to create this snapshot. "sourceDiskEncryptionKey": { # The customer-supplied @@ -1305,8 +1306,9 @@

Method Details

# encryption key that protects this resource. }, "snapshotGroupId": "A String", # Output only. [Output Only] The unique ID of the snapshot group that this snapshot - # belongs to. - "snapshotGroupName": "A String", # Output only. [Output only] The snapshot group that this snapshot belongs to. + # belongs to. The usage of snapshot group feature is restricted. + "snapshotGroupName": "A String", # Output only. [Output only] The snapshot group that this snapshot belongs to. The usage + # of snapshot group feature is restricted. "snapshotType": "A String", # Indicates the type of the snapshot. "sourceDisk": "A String", # The source disk used to create this snapshot. "sourceDiskEncryptionKey": { # The customer-supplied @@ -2014,8 +2016,9 @@

Method Details

# encryption key that protects this resource. }, "snapshotGroupId": "A String", # Output only. [Output Only] The unique ID of the snapshot group that this snapshot - # belongs to. - "snapshotGroupName": "A String", # Output only. [Output only] The snapshot group that this snapshot belongs to. + # belongs to. The usage of snapshot group feature is restricted. + "snapshotGroupName": "A String", # Output only. [Output only] The snapshot group that this snapshot belongs to. The usage + # of snapshot group feature is restricted. "snapshotType": "A String", # Indicates the type of the snapshot. "sourceDisk": "A String", # The source disk used to create this snapshot. "sourceDiskEncryptionKey": { # The customer-supplied diff --git a/docs/dyn/compute_beta.snapshots.html b/docs/dyn/compute_beta.snapshots.html index 79aabe892c..cedcd95dc9 100644 --- a/docs/dyn/compute_beta.snapshots.html +++ b/docs/dyn/compute_beta.snapshots.html @@ -403,8 +403,9 @@

Method Details

# encryption key that protects this resource. }, "snapshotGroupId": "A String", # Output only. [Output Only] The unique ID of the snapshot group that this snapshot - # belongs to. - "snapshotGroupName": "A String", # Output only. [Output only] The snapshot group that this snapshot belongs to. + # belongs to. The usage of snapshot group feature is restricted. + "snapshotGroupName": "A String", # Output only. [Output only] The snapshot group that this snapshot belongs to. The usage + # of snapshot group feature is restricted. "snapshotType": "A String", # Indicates the type of the snapshot. "sourceDisk": "A String", # The source disk used to create this snapshot. "sourceDiskEncryptionKey": { # The customer-supplied @@ -1125,8 +1126,9 @@

Method Details

# encryption key that protects this resource. }, "snapshotGroupId": "A String", # Output only. [Output Only] The unique ID of the snapshot group that this snapshot - # belongs to. - "snapshotGroupName": "A String", # Output only. [Output only] The snapshot group that this snapshot belongs to. + # belongs to. The usage of snapshot group feature is restricted. + "snapshotGroupName": "A String", # Output only. [Output only] The snapshot group that this snapshot belongs to. The usage + # of snapshot group feature is restricted. "snapshotType": "A String", # Indicates the type of the snapshot. "sourceDisk": "A String", # The source disk used to create this snapshot. "sourceDiskEncryptionKey": { # The customer-supplied @@ -1829,8 +1831,9 @@

Method Details

# encryption key that protects this resource. }, "snapshotGroupId": "A String", # Output only. [Output Only] The unique ID of the snapshot group that this snapshot - # belongs to. - "snapshotGroupName": "A String", # Output only. [Output only] The snapshot group that this snapshot belongs to. + # belongs to. The usage of snapshot group feature is restricted. + "snapshotGroupName": "A String", # Output only. [Output only] The snapshot group that this snapshot belongs to. The usage + # of snapshot group feature is restricted. "snapshotType": "A String", # Indicates the type of the snapshot. "sourceDisk": "A String", # The source disk used to create this snapshot. "sourceDiskEncryptionKey": { # The customer-supplied @@ -2537,8 +2540,9 @@

Method Details

# encryption key that protects this resource. }, "snapshotGroupId": "A String", # Output only. [Output Only] The unique ID of the snapshot group that this snapshot - # belongs to. - "snapshotGroupName": "A String", # Output only. [Output only] The snapshot group that this snapshot belongs to. + # belongs to. The usage of snapshot group feature is restricted. + "snapshotGroupName": "A String", # Output only. [Output only] The snapshot group that this snapshot belongs to. The usage + # of snapshot group feature is restricted. "snapshotType": "A String", # Indicates the type of the snapshot. "sourceDisk": "A String", # The source disk used to create this snapshot. "sourceDiskEncryptionKey": { # The customer-supplied diff --git a/docs/dyn/compute_v1.disks.html b/docs/dyn/compute_v1.disks.html index b196d53fea..dc4f7e0035 100644 --- a/docs/dyn/compute_v1.disks.html +++ b/docs/dyn/compute_v1.disks.html @@ -1165,6 +1165,34 @@

Method Details

{ # A transient resource used in compute.disks.bulkInsert and # compute.regionDisks.bulkInsert. It is only used to process # requests and is not persisted. + "instantSnapshotGroupParameters": { # The parameters for the instant snapshot group. + "sourceInstantSnapshotGroup": "A String", # The source instant snapshot group used to create disks. You can provide + # this as a partial or full URL to the resource. For example, the following + # are valid values: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instantSnapshotGroups/instantSnapshotGroup + # - projects/project/zones/zone/instantSnapshotGroups/instantSnapshotGroup + # - zones/zone/instantSnapshotGroups/instantSnapshotGroup + }, + "snapshotGroupParameters": { # The parameters for the snapshot group. The usage of snapshot group feature + # is restricted. + "replicaZones": [ # URLs of the zones where disks should be replicated to. Only applicable + # for regional resources. + "A String", + ], + "sourceSnapshotGroup": "A String", # The source snapshot group used to create disks. You can provide this as a + # partial or full URL to the resource. For example, the following are valid + # values: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/global/snapshotGroups/snapshotGroup + # - projects/project/global/snapshotGroups/snapshotGroup + # - global/snapshotGroups/snapshotGroup + "type": "A String", # URL of the disk type resource describing which disk type to use to create + # disks. Provide this when creating the disk. For example:projects/project/zones/zone/diskTypes/pd-ssd. See Persistent disk + # types. + }, "sourceConsistencyGroupPolicy": "A String", # The URL of the DiskConsistencyGroupPolicy for the group of disks to clone. # This may be a full or partial URL, such as: # @@ -1898,6 +1926,8 @@

Method Details

"a_key": "A String", }, }, + "region": "A String", # Output only. [Output Only] URL of the region where the snapshot resides. Only applicable + # for regional snapshots. "satisfiesPzi": True or False, # Output only. Reserved for future use. "satisfiesPzs": True or False, # Output only. [Output Only] Reserved for future use. "selfLink": "A String", # Output only. [Output Only] Server-defined URL for the resource. @@ -1966,6 +1996,10 @@

Method Details

# 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, + "snapshotGroupId": "A String", # Output only. [Output Only] The unique ID of the snapshot group that this snapshot + # belongs to. The usage of snapshot group feature is restricted. + "snapshotGroupName": "A String", # Output only. [Output only] The snapshot group that this snapshot belongs to. The usage + # of snapshot group feature is restricted. "snapshotType": "A String", # Indicates the type of the snapshot. "sourceDisk": "A String", # The source disk used to create this snapshot. "sourceDiskEncryptionKey": { # The customer-supplied diff --git a/docs/dyn/compute_v1.html b/docs/dyn/compute_v1.html index e4d46ff878..18d607a36e 100644 --- a/docs/dyn/compute_v1.html +++ b/docs/dyn/compute_v1.html @@ -229,6 +229,11 @@

Instance Methods

Returns the instances Resource.

+

+ instantSnapshotGroups() +

+

Returns the instantSnapshotGroups Resource.

+

instantSnapshots()

@@ -439,6 +444,11 @@

Instance Methods

Returns the regionInstances Resource.

+

+ regionInstantSnapshotGroups() +

+

Returns the regionInstantSnapshotGroups Resource.

+

regionInstantSnapshots()

@@ -469,6 +479,16 @@

Instance Methods

Returns the regionSecurityPolicies Resource.

+

+ regionSnapshotSettings() +

+

Returns the regionSnapshotSettings Resource.

+ +

+ regionSnapshots() +

+

Returns the regionSnapshots Resource.

+

regionSslCertificates()

diff --git a/docs/dyn/compute_v1.instanceTemplates.html b/docs/dyn/compute_v1.instanceTemplates.html index fd83d80ef2..41163c15c6 100644 --- a/docs/dyn/compute_v1.instanceTemplates.html +++ b/docs/dyn/compute_v1.instanceTemplates.html @@ -87,7 +87,7 @@

Instance Methods

delete(project, instanceTemplate, requestId=None, x__xgafv=None)

Deletes the specified instance template. Deleting an instance template is

- get(project, instanceTemplate, view=None, x__xgafv=None)

+ get(project, instanceTemplate, x__xgafv=None)

Returns the specified instance template.

getIamPolicy(project, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)

@@ -96,7 +96,7 @@

Instance Methods

insert(project, body=None, requestId=None, x__xgafv=None)

Creates an instance template in the specified project using the

- list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, view=None, x__xgafv=None)

+ list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Retrieves a list of instance templates that are contained within

list_next()

@@ -967,15 +967,6 @@

Method Details

"networkPerformanceConfig": { # Note that for MachineImage, this is not supported yet. "totalEgressBandwidthTier": "A String", }, - "partnerMetadata": { # Partner Metadata assigned to the instance properties. A map from a - # subdomain (namespace) to entries map. - "a_key": { - "entries": { # Map of a partner metadata that belong to the same subdomain. - # It accepts any value including google.protobuf.Struct. - "a_key": "", - }, - }, - }, "privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for VMs. # If not specified, use INHERIT_FROM_SUBNETWORK as default. # Note that for MachineImage, this is not supported yet. @@ -1554,17 +1545,12 @@

Method Details

- get(project, instanceTemplate, view=None, x__xgafv=None) + get(project, instanceTemplate, x__xgafv=None)
Returns the specified instance template.
 
 Args:
   project: string, Project ID for this request. (required)
   instanceTemplate: string, The name of the instance template. (required)
-  view: string, View of the instance template.
-    Allowed values
-      BASIC - Include everything except Partner Metadata.
-      FULL - Include everything.
-      INSTANCE_VIEW_UNSPECIFIED - The default / unset value. The API will default to the BASIC view.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -2316,15 +2302,6 @@ 

Method Details

"networkPerformanceConfig": { # Note that for MachineImage, this is not supported yet. "totalEgressBandwidthTier": "A String", }, - "partnerMetadata": { # Partner Metadata assigned to the instance properties. A map from a - # subdomain (namespace) to entries map. - "a_key": { - "entries": { # Map of a partner metadata that belong to the same subdomain. - # It accepts any value including google.protobuf.Struct. - "a_key": "", - }, - }, - }, "privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for VMs. # If not specified, use INHERIT_FROM_SUBNETWORK as default. # Note that for MachineImage, this is not supported yet. @@ -3651,15 +3628,6 @@

Method Details

"networkPerformanceConfig": { # Note that for MachineImage, this is not supported yet. "totalEgressBandwidthTier": "A String", }, - "partnerMetadata": { # Partner Metadata assigned to the instance properties. A map from a - # subdomain (namespace) to entries map. - "a_key": { - "entries": { # Map of a partner metadata that belong to the same subdomain. - # It accepts any value including google.protobuf.Struct. - "a_key": "", - }, - }, - }, "privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for VMs. # If not specified, use INHERIT_FROM_SUBNETWORK as default. # Note that for MachineImage, this is not supported yet. @@ -4147,7 +4115,7 @@

Method Details

- list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, view=None, x__xgafv=None) + list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Retrieves a list of instance templates that are contained within
 the specified project.
 
@@ -4236,11 +4204,6 @@ 

Method Details

For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - view: string, View of the instance template. - Allowed values - BASIC - Include everything except Partner Metadata. - FULL - Include everything. - INSTANCE_VIEW_UNSPECIFIED - The default / unset value. The API will default to the BASIC view. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -4995,15 +4958,6 @@

Method Details

"networkPerformanceConfig": { # Note that for MachineImage, this is not supported yet. "totalEgressBandwidthTier": "A String", }, - "partnerMetadata": { # Partner Metadata assigned to the instance properties. A map from a - # subdomain (namespace) to entries map. - "a_key": { - "entries": { # Map of a partner metadata that belong to the same subdomain. - # It accepts any value including google.protobuf.Struct. - "a_key": "", - }, - }, - }, "privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for VMs. # If not specified, use INHERIT_FROM_SUBNETWORK as default. # Note that for MachineImage, this is not supported yet. diff --git a/docs/dyn/compute_v1.instances.html b/docs/dyn/compute_v1.instances.html index d2b3ab5a96..85556419ee 100644 --- a/docs/dyn/compute_v1.instances.html +++ b/docs/dyn/compute_v1.instances.html @@ -111,7 +111,7 @@

Instance Methods

detachDisk(project, zone, instance, deviceName, requestId=None, x__xgafv=None)

Detaches a disk from an instance.

- get(project, zone, instance, view=None, x__xgafv=None)

+ get(project, zone, instance, x__xgafv=None)

Returns the specified Instance resource.

getEffectiveFirewalls(project, zone, instance, networkInterface, x__xgafv=None)

@@ -122,9 +122,6 @@

Instance Methods

getIamPolicy(project, zone, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)

Gets the access control policy for a resource. May be empty if no such

-

- getPartnerMetadata(project, zone, instance, namespaces=None, x__xgafv=None)

-

Gets partner metadata of the specified instance and namespaces.

getScreenshot(project, zone, instance, x__xgafv=None)

Returns the screenshot from the specified instance.

@@ -138,7 +135,7 @@

Instance Methods

insert(project, zone, body=None, requestId=None, sourceInstanceTemplate=None, sourceMachineImage=None, x__xgafv=None)

Creates an instance resource in the specified project using the data

- list(project, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, view=None, x__xgafv=None)

+ list(project, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Retrieves the list of instances contained within

listReferrers(project, zone, instance, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

@@ -149,9 +146,6 @@

Instance Methods

list_next()

Retrieves the next page of results.

-

- patchPartnerMetadata(project, zone, instance, body=None, requestId=None, x__xgafv=None)

-

Patches partner metadata of the specified instance.

performMaintenance(project, zone, instance, requestId=None, x__xgafv=None)

Perform a manual maintenance on the instance.

@@ -2343,15 +2337,6 @@

Method Details

"a_key": "A String", }, }, - "partnerMetadata": { # Partner Metadata assigned to the instance. A map from a subdomain - # (namespace) to entries map. - "a_key": { - "entries": { # Map of a partner metadata that belong to the same subdomain. - # It accepts any value including google.protobuf.Struct. - "a_key": "", - }, - }, - }, "privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for the VM. # If not specified, use INHERIT_FROM_SUBNETWORK as default. "reservationAffinity": { # Specifies the reservations that this instance can consume from. # Specifies the reservations that this instance can consume from. @@ -4632,15 +4617,6 @@

Method Details

"networkPerformanceConfig": { # Note that for MachineImage, this is not supported yet. "totalEgressBandwidthTier": "A String", }, - "partnerMetadata": { # Partner Metadata assigned to the instance properties. A map from a - # subdomain (namespace) to entries map. - "a_key": { - "entries": { # Map of a partner metadata that belong to the same subdomain. - # It accepts any value including google.protobuf.Struct. - "a_key": "", - }, - }, - }, "privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for VMs. # If not specified, use INHERIT_FROM_SUBNETWORK as default. # Note that for MachineImage, this is not supported yet. @@ -6345,18 +6321,13 @@

Method Details

- get(project, zone, instance, view=None, x__xgafv=None) + get(project, zone, instance, x__xgafv=None)
Returns the specified Instance resource.
 
 Args:
   project: string, Project ID for this request. (required)
   zone: string, The name of the zone for this request. (required)
   instance: string, Name of the instance resource to return. (required)
-  view: string, View of the instance.
-    Allowed values
-      BASIC - Include everything except Partner Metadata.
-      FULL - Include everything.
-      INSTANCE_VIEW_UNSPECIFIED - The default / unset value. The API will default to the BASIC view.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -7220,15 +7191,6 @@ 

Method Details

"a_key": "A String", }, }, - "partnerMetadata": { # Partner Metadata assigned to the instance. A map from a subdomain - # (namespace) to entries map. - "a_key": { - "entries": { # Map of a partner metadata that belong to the same subdomain. - # It accepts any value including google.protobuf.Struct. - "a_key": "", - }, - }, - }, "privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for the VM. # If not specified, use INHERIT_FROM_SUBNETWORK as default. "reservationAffinity": { # Specifies the reservations that this instance can consume from. # Specifies the reservations that this instance can consume from. @@ -8458,43 +8420,6 @@

Method Details

}
-
- getPartnerMetadata(project, zone, instance, namespaces=None, x__xgafv=None) -
Gets partner metadata of the specified instance and namespaces.
-
-Args:
-  project: string, Project ID for this request. (required)
-  zone: string, The name of the zone for this request. (required)
-  instance: string, Name of the instance scoping this request. (required)
-  namespaces: string, Comma separated partner metadata namespaces.
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # Model definition of partner_metadata field.
-    # To be used in dedicated Partner Metadata methods and to be inlined in
-    # the Instance and InstanceTemplate resources.
-  "fingerprint": "A String", # Instance-level hash to be used for optimistic
-      # locking.
-  "partnerMetadata": { # Partner Metadata assigned to the instance. A map from a subdomain to
-      # entries map. Subdomain name must be compliant withRFC1035
-      # definition. The total size of all keys and values must be less than 2MB.
-      # Subdomain 'metadata.compute.googleapis.com' is reserverd for instance's
-      # metadata.
-    "a_key": {
-      "entries": { # Map of a partner metadata that belong to the same subdomain.
-          # It accepts any value including google.protobuf.Struct.
-        "a_key": "",
-      },
-    },
-  },
-}
-
-
getScreenshot(project, zone, instance, x__xgafv=None)
Returns the screenshot from the specified instance.
@@ -9477,15 +9402,6 @@ 

Method Details

"a_key": "A String", }, }, - "partnerMetadata": { # Partner Metadata assigned to the instance. A map from a subdomain - # (namespace) to entries map. - "a_key": { - "entries": { # Map of a partner metadata that belong to the same subdomain. - # It accepts any value including google.protobuf.Struct. - "a_key": "", - }, - }, - }, "privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for the VM. # If not specified, use INHERIT_FROM_SUBNETWORK as default. "reservationAffinity": { # Specifies the reservations that this instance can consume from. # Specifies the reservations that this instance can consume from. @@ -10070,7 +9986,7 @@

Method Details

- list(project, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, view=None, x__xgafv=None) + list(project, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Retrieves the list of instances contained within
 the specified zone.
 
@@ -10160,11 +10076,6 @@ 

Method Details

For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - view: string, View of the instance. - Allowed values - BASIC - Include everything except Partner Metadata. - FULL - Include everything. - INSTANCE_VIEW_UNSPECIFIED - The default / unset value. The API will default to the BASIC view. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -11031,15 +10942,6 @@

Method Details

"a_key": "A String", }, }, - "partnerMetadata": { # Partner Metadata assigned to the instance. A map from a subdomain - # (namespace) to entries map. - "a_key": { - "entries": { # Map of a partner metadata that belong to the same subdomain. - # It accepts any value including google.protobuf.Struct. - "a_key": "", - }, - }, - }, "privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for the VM. # If not specified, use INHERIT_FROM_SUBNETWORK as default. "reservationAffinity": { # Specifies the reservations that this instance can consume from. # Specifies the reservations that this instance can consume from. @@ -11538,321 +11440,6 @@

Method Details

-
- patchPartnerMetadata(project, zone, instance, body=None, requestId=None, x__xgafv=None) -
Patches partner metadata of the specified instance.
-
-Args:
-  project: string, Project ID for this request. (required)
-  zone: string, The name of the zone for this request. (required)
-  instance: string, Name of the instance scoping this request. (required)
-  body: object, The request body.
-    The object takes the form of:
-
-{ # Model definition of partner_metadata field.
-    # To be used in dedicated Partner Metadata methods and to be inlined in
-    # the Instance and InstanceTemplate resources.
-  "fingerprint": "A String", # Instance-level hash to be used for optimistic
-      # locking.
-  "partnerMetadata": { # Partner Metadata assigned to the instance. A map from a subdomain to
-      # entries map. Subdomain name must be compliant withRFC1035
-      # definition. The total size of all keys and values must be less than 2MB.
-      # Subdomain 'metadata.compute.googleapis.com' is reserverd for instance's
-      # metadata.
-    "a_key": {
-      "entries": { # Map of a partner metadata that belong to the same subdomain.
-          # It accepts any value including google.protobuf.Struct.
-        "a_key": "",
-      },
-    },
-  },
-}
-
-  requestId: string, An optional request ID to identify requests. Specify a unique request ID so
-that if you must retry your request, the server will know to ignore the
-request if it has already been completed.
-
-For example, consider a situation where you make an initial request and
-the request times out. If you make the request again with the same
-request ID, the server can check if original operation with the same
-request ID was received, and if so, will ignore the second request. This
-prevents clients from accidentally creating duplicate commitments.
-
-The request ID must be
-a valid UUID with the exception that zero UUID is not supported
-(00000000-0000-0000-0000-000000000000).
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # Represents an Operation resource.
-    #
-    # Google Compute Engine has three Operation resources:
-    #
-    # * [Global](/compute/docs/reference/rest/v1/globalOperations)
-    # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
-    # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
-    #
-    # You can use an operation resource to manage asynchronous API requests.
-    # For more information, readHandling
-    # API responses.
-    #
-    # Operations can be global, regional or zonal.
-    #
-    #    - For global operations, use the `globalOperations`
-    #    resource.
-    #    - For regional operations, use the
-    #    `regionOperations` resource.
-    #    - For zonal operations, use
-    #    the `zoneOperations` resource.
-    #
-    #
-    #
-    # For more information, read
-    # Global, Regional, and Zonal Resources.
-    #
-    # Note that completed Operation resources have a limited
-    # retention period.
-  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
-      # Not present otherwise.
-  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
-  "description": "A String", # [Output Only] A textual description of the operation, which is
-      # set when the operation is created.
-  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
-      # text format.
-  "error": { # [Output Only] If errors are generated during processing of the operation,
-      # this field will be populated.
-    "errors": [ # [Output Only] The array of errors encountered while processing this
-        # operation.
-      {
-        "code": "A String", # [Output Only] The error type identifier for this error.
-        "errorDetails": [ # [Output Only] An optional list of messages that contain the error
-            # details. There is a set of defined message types to use for providing
-            # details.The syntax depends on the error code. For example,
-            # QuotaExceededInfo will have details when the error code is
-            # QUOTA_EXCEEDED.
-          {
-            "errorInfo": { # Describes the cause of the error with structured details.
-                #
-                # Example of an error when contacting the "pubsub.googleapis.com" API when it
-                # is not enabled:
-                #
-                #     { "reason": "API_DISABLED"
-                #       "domain": "googleapis.com"
-                #       "metadata": {
-                #         "resource": "projects/123",
-                #         "service": "pubsub.googleapis.com"
-                #       }
-                #     }
-                #
-                # This response indicates that the pubsub.googleapis.com API is not enabled.
-                #
-                # Example of an error that is returned when attempting to create a Spanner
-                # instance in a region that is out of stock:
-                #
-                #     { "reason": "STOCKOUT"
-                #       "domain": "spanner.googleapis.com",
-                #       "metadata": {
-                #         "availableRegions": "us-central1,us-east2"
-                #       }
-                #     }
-              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
-                  # is typically the registered service name of the tool or product that
-                  # generates the error. Example: "pubsub.googleapis.com". If the error is
-                  # generated by some common infrastructure, the error domain must be a
-                  # globally unique value that identifies the infrastructure. For Google API
-                  # infrastructure, the error domain is "googleapis.com".
-              "metadatas": { # Additional structured details about this error.
-                  #
-                  # Keys must match a regular expression of `a-z+` but should
-                  # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
-                  # length. When identifying the current value of an exceeded limit, the units
-                  # should be contained in the key, not the value.  For example, rather than
-                  # `{"instanceLimit": "100/request"}`, should be returned as,
-                  # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
-                  # instances that can be created in a single (batch) request.
-                "a_key": "A String",
-              },
-              "reason": "A String", # The reason of the error. This is a constant value that identifies the
-                  # proximate cause of the error. Error reasons are unique within a particular
-                  # domain of errors. This should be at most 63 characters and match a
-                  # regular expression of `A-Z+[A-Z0-9]`, which represents
-                  # UPPER_SNAKE_CASE.
-            },
-            "help": { # Provides links to documentation or for performing an out of band action.
-                #
-                # For example, if a quota check failed with an error indicating the calling
-                # project hasn't enabled the accessed service, this can contain a URL pointing
-                # directly to the right place in the developer console to flip the bit.
-              "links": [ # URL(s) pointing to additional information on handling the current error.
-                { # Describes a URL link.
-                  "description": "A String", # Describes what the link offers.
-                  "url": "A String", # The URL of the link.
-                },
-              ],
-            },
-            "localizedMessage": { # Provides a localized error message that is safe to return to the user
-                # which can be attached to an RPC error.
-              "locale": "A String", # The locale used following the specification defined at
-                  # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
-                  # Examples are: "en-US", "fr-CH", "es-MX"
-              "message": "A String", # The localized error message in the above locale.
-            },
-            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
-              "dimensions": { # The map holding related quota dimensions.
-                "a_key": "A String",
-              },
-              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
-                  #  type or metric.
-              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
-                  # or metric.
-              "limitName": "A String", # The name of the quota limit.
-              "metricName": "A String", # The Compute Engine quota metric name.
-              "rolloutStatus": "A String", # Rollout status of the future quota limit.
-            },
-          },
-        ],
-        "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
-            # This property is optional.
-        "message": "A String", # [Output Only] An optional, human-readable error message.
-      },
-    ],
-  },
-  "getVersionOperationMetadata": {
-    "inlineSbomInfo": {
-      "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
-          # name and the value is the version.
-        "a_key": "A String",
-      },
-      "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
-          # component name and the value is the version.
-        "a_key": "A String",
-      },
-    },
-  },
-  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
-      # message that was returned, such as `NOT FOUND`.
-  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
-      # status code that was returned. For example, a `404` means the
-      # resource was not found.
-  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
-      # defined by the server.
-  "insertTime": "A String", # [Output Only] The time that this operation was requested.
-      # This value is inRFC3339
-      # text format.
-  "instancesBulkInsertOperationMetadata": {
-    "perLocationStatus": { # Status information per location (location name is key).
-        # Example key: zones/us-central1-a
-      "a_key": {
-        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
-        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
-        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
-            # error.
-        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
-            # if the flow is rolling forward or rolling back.
-        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
-      },
-    },
-  },
-  "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
-      # Operation resources.
-  "name": "A String", # [Output Only] Name of the operation.
-  "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
-      # group of operations results from a `bulkInsert` API request.
-  "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
-      # `update`, or `delete`, and so on.
-  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
-      # There is no requirement that this be linear or support any granularity of
-      # operations. This should not be used to guess when the operation will be
-      # complete. This number should monotonically increase as the operation
-      # progresses.
-  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
-      # applicable when performing regional operations.
-  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
-  "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
-      # this field will contain information on all underlying zonal actions and
-      # their state.
-    "clientOperationId": "A String", # [Output Only] The client operation id.
-    "perLocationOperations": { # [Output Only] Status information per location (location name is key).
-        # Example key: zones/us-central1-a
-      "a_key": {
-        "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
-            # populated.
-            # different programming environments, including REST APIs and RPC APIs. It is
-            # used by [gRPC](https://github.com/grpc). Each `Status` message contains
-            # three pieces of data: error code, error message, and error details.
-            #
-            # You can find out more about this error model and how to work with it in the
-            # [API Design Guide](https://cloud.google.com/apis/design/errors).
-          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
-          "details": [ # A list of messages that carry the error details.  There is a common set of
-              # message types for APIs to use.
-            {
-              "a_key": "", # Properties of the object. Contains field @type with type URL.
-            },
-          ],
-          "message": "A String", # A developer-facing error message, which should be in English. Any
-              # user-facing error message should be localized and sent in the
-              # google.rpc.Status.details field, or localized by the client.
-        },
-        "state": "A String", # [Output Only] Status of the action, which can be one of the following:
-            # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
-      },
-    },
-  },
-  "startTime": "A String", # [Output Only] The time that this operation was started by the server.
-      # This value is inRFC3339
-      # text format.
-  "status": "A String", # [Output Only] The status of the operation, which can be one of the
-      # following:
-      # `PENDING`, `RUNNING`, or `DONE`.
-  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
-      # operation.
-  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
-      # of the target resource.
-  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
-      # operations related to creating a snapshot, this points to the disk
-      # that the snapshot was created from.
-  "user": "A String", # [Output Only] User who requested the operation, for example:
-      # `user@example.com` or
-      # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
-  "warnings": [ # [Output Only] If warning messages are generated during processing of the
-      # operation, this field will be populated.
-    {
-      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
-          # Engine returns NO_RESULTS_ON_PAGE if there
-          # are no results in the response.
-      "data": [ # [Output Only] Metadata about this warning in key:
-          # value format. For example:
-          #
-          # "data": [
-          #   {
-          #    "key": "scope",
-          #    "value": "zones/us-east1-d"
-          #   }
-        {
-          "key": "A String", # [Output Only] A key that provides more detail on the warning being
-              # returned. For example, for warnings where there are no results in a list
-              # request for a particular zone, this key might be scope and
-              # the key value might be the zone name. Other examples might be a key
-              # indicating a deprecated resource and a suggested replacement, or a
-              # warning about invalid network settings (for example, if an instance
-              # attempts to perform IP forwarding but is not enabled for IP forwarding).
-          "value": "A String", # [Output Only] A warning data value corresponding to the key.
-        },
-      ],
-      "message": "A String", # [Output Only] A human-readable description of the warning code.
-    },
-  ],
-  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
-      # applicable when performing per-zone operations.
-}
-
-
performMaintenance(project, zone, instance, requestId=None, x__xgafv=None)
Perform a manual maintenance on the instance.
@@ -20758,15 +20345,6 @@ 

Method Details

"a_key": "A String", }, }, - "partnerMetadata": { # Partner Metadata assigned to the instance. A map from a subdomain - # (namespace) to entries map. - "a_key": { - "entries": { # Map of a partner metadata that belong to the same subdomain. - # It accepts any value including google.protobuf.Struct. - "a_key": "", - }, - }, - }, "privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for the VM. # If not specified, use INHERIT_FROM_SUBNETWORK as default. "reservationAffinity": { # Specifies the reservations that this instance can consume from. # Specifies the reservations that this instance can consume from. diff --git a/docs/dyn/compute_v1.instantSnapshotGroups.html b/docs/dyn/compute_v1.instantSnapshotGroups.html new file mode 100644 index 0000000000..4c354b642c --- /dev/null +++ b/docs/dyn/compute_v1.instantSnapshotGroups.html @@ -0,0 +1,2264 @@ + + + +

Compute Engine API . instantSnapshotGroups

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ delete(project, zone, instantSnapshotGroup, requestId=None, x__xgafv=None)

+

deletes a Zonal InstantSnapshotGroup resource

+

+ get(project, zone, instantSnapshotGroup, x__xgafv=None)

+

returns the specified InstantSnapshotGroup resource in the specified zone.

+

+ getIamPolicy(project, zone, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)

+

Gets the access control policy for a resource. May be empty if no such

+

+ insert(project, zone, body=None, requestId=None, sourceConsistencyGroup=None, x__xgafv=None)

+

inserts a Zonal InstantSnapshotGroup resource

+

+ list(project, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

retrieves the list of InstantSnapshotGroup resources contained within

+

+ list_next()

+

Retrieves the next page of results.

+

+ setIamPolicy(project, zone, resource, body=None, x__xgafv=None)

+

Sets the access control policy on the specified resource.

+

+ testIamPermissions(project, zone, resource, body=None, x__xgafv=None)

+

Returns permissions that a caller has on the specified resource.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ delete(project, zone, instantSnapshotGroup, requestId=None, x__xgafv=None) +
deletes a Zonal InstantSnapshotGroup resource
+
+Args:
+  project: string, Project ID for this request. (required)
+  zone: string, The name of the zone for this request. (required)
+  instantSnapshotGroup: string, Name of the InstantSnapshot resource to delete. (required)
+  requestId: string, An optional request ID to identify requests. Specify a unique request ID so
+that if you must retry your request, the server will know to ignore the
+request if it has already been completed.
+
+For example, consider a situation where you make an initial request and
+the request times out. If you make the request again with the same
+request ID, the server can check if original operation with the same
+request ID was received, and if so, will ignore the second request. This
+prevents clients from accidentally creating duplicate commitments.
+
+The request ID must be
+a valid UUID with the exception that zero UUID is not supported
+(00000000-0000-0000-0000-000000000000).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an Operation resource.
+    #
+    # Google Compute Engine has three Operation resources:
+    #
+    # * [Global](/compute/docs/reference/rest/v1/globalOperations)
+    # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
+    # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
+    #
+    # You can use an operation resource to manage asynchronous API requests.
+    # For more information, readHandling
+    # API responses.
+    #
+    # Operations can be global, regional or zonal.
+    #
+    #    - For global operations, use the `globalOperations`
+    #    resource.
+    #    - For regional operations, use the
+    #    `regionOperations` resource.
+    #    - For zonal operations, use
+    #    the `zoneOperations` resource.
+    #
+    #
+    #
+    # For more information, read
+    # Global, Regional, and Zonal Resources.
+    #
+    # Note that completed Operation resources have a limited
+    # retention period.
+  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
+      # Not present otherwise.
+  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+  "description": "A String", # [Output Only] A textual description of the operation, which is
+      # set when the operation is created.
+  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
+      # text format.
+  "error": { # [Output Only] If errors are generated during processing of the operation,
+      # this field will be populated.
+    "errors": [ # [Output Only] The array of errors encountered while processing this
+        # operation.
+      {
+        "code": "A String", # [Output Only] The error type identifier for this error.
+        "errorDetails": [ # [Output Only] An optional list of messages that contain the error
+            # details. There is a set of defined message types to use for providing
+            # details.The syntax depends on the error code. For example,
+            # QuotaExceededInfo will have details when the error code is
+            # QUOTA_EXCEEDED.
+          {
+            "errorInfo": { # Describes the cause of the error with structured details.
+                #
+                # Example of an error when contacting the "pubsub.googleapis.com" API when it
+                # is not enabled:
+                #
+                #     { "reason": "API_DISABLED"
+                #       "domain": "googleapis.com"
+                #       "metadata": {
+                #         "resource": "projects/123",
+                #         "service": "pubsub.googleapis.com"
+                #       }
+                #     }
+                #
+                # This response indicates that the pubsub.googleapis.com API is not enabled.
+                #
+                # Example of an error that is returned when attempting to create a Spanner
+                # instance in a region that is out of stock:
+                #
+                #     { "reason": "STOCKOUT"
+                #       "domain": "spanner.googleapis.com",
+                #       "metadata": {
+                #         "availableRegions": "us-central1,us-east2"
+                #       }
+                #     }
+              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+                  # is typically the registered service name of the tool or product that
+                  # generates the error. Example: "pubsub.googleapis.com". If the error is
+                  # generated by some common infrastructure, the error domain must be a
+                  # globally unique value that identifies the infrastructure. For Google API
+                  # infrastructure, the error domain is "googleapis.com".
+              "metadatas": { # Additional structured details about this error.
+                  #
+                  # Keys must match a regular expression of `a-z+` but should
+                  # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+                  # length. When identifying the current value of an exceeded limit, the units
+                  # should be contained in the key, not the value.  For example, rather than
+                  # `{"instanceLimit": "100/request"}`, should be returned as,
+                  # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+                  # instances that can be created in a single (batch) request.
+                "a_key": "A String",
+              },
+              "reason": "A String", # The reason of the error. This is a constant value that identifies the
+                  # proximate cause of the error. Error reasons are unique within a particular
+                  # domain of errors. This should be at most 63 characters and match a
+                  # regular expression of `A-Z+[A-Z0-9]`, which represents
+                  # UPPER_SNAKE_CASE.
+            },
+            "help": { # Provides links to documentation or for performing an out of band action.
+                #
+                # For example, if a quota check failed with an error indicating the calling
+                # project hasn't enabled the accessed service, this can contain a URL pointing
+                # directly to the right place in the developer console to flip the bit.
+              "links": [ # URL(s) pointing to additional information on handling the current error.
+                { # Describes a URL link.
+                  "description": "A String", # Describes what the link offers.
+                  "url": "A String", # The URL of the link.
+                },
+              ],
+            },
+            "localizedMessage": { # Provides a localized error message that is safe to return to the user
+                # which can be attached to an RPC error.
+              "locale": "A String", # The locale used following the specification defined at
+                  # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+                  # Examples are: "en-US", "fr-CH", "es-MX"
+              "message": "A String", # The localized error message in the above locale.
+            },
+            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+              "dimensions": { # The map holding related quota dimensions.
+                "a_key": "A String",
+              },
+              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+                  #  type or metric.
+              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+                  # or metric.
+              "limitName": "A String", # The name of the quota limit.
+              "metricName": "A String", # The Compute Engine quota metric name.
+              "rolloutStatus": "A String", # Rollout status of the future quota limit.
+            },
+          },
+        ],
+        "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+            # This property is optional.
+        "message": "A String", # [Output Only] An optional, human-readable error message.
+      },
+    ],
+  },
+  "getVersionOperationMetadata": {
+    "inlineSbomInfo": {
+      "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+          # name and the value is the version.
+        "a_key": "A String",
+      },
+      "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+          # component name and the value is the version.
+        "a_key": "A String",
+      },
+    },
+  },
+  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
+      # message that was returned, such as `NOT FOUND`.
+  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
+      # status code that was returned. For example, a `404` means the
+      # resource was not found.
+  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
+      # defined by the server.
+  "insertTime": "A String", # [Output Only] The time that this operation was requested.
+      # This value is inRFC3339
+      # text format.
+  "instancesBulkInsertOperationMetadata": {
+    "perLocationStatus": { # Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
+            # error.
+        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
+            # if the flow is rolling forward or rolling back.
+        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+      },
+    },
+  },
+  "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
+      # Operation resources.
+  "name": "A String", # [Output Only] Name of the operation.
+  "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
+      # group of operations results from a `bulkInsert` API request.
+  "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
+      # `update`, or `delete`, and so on.
+  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
+      # There is no requirement that this be linear or support any granularity of
+      # operations. This should not be used to guess when the operation will be
+      # complete. This number should monotonically increase as the operation
+      # progresses.
+  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
+      # applicable when performing regional operations.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
+      # this field will contain information on all underlying zonal actions and
+      # their state.
+    "clientOperationId": "A String", # [Output Only] The client operation id.
+    "perLocationOperations": { # [Output Only] Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
+            # populated.
+            # different programming environments, including REST APIs and RPC APIs. It is
+            # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+            # three pieces of data: error code, error message, and error details.
+            #
+            # You can find out more about this error model and how to work with it in the
+            # [API Design Guide](https://cloud.google.com/apis/design/errors).
+          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+          "details": [ # A list of messages that carry the error details.  There is a common set of
+              # message types for APIs to use.
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+          "message": "A String", # A developer-facing error message, which should be in English. Any
+              # user-facing error message should be localized and sent in the
+              # google.rpc.Status.details field, or localized by the client.
+        },
+        "state": "A String", # [Output Only] Status of the action, which can be one of the following:
+            # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+      },
+    },
+  },
+  "startTime": "A String", # [Output Only] The time that this operation was started by the server.
+      # This value is inRFC3339
+      # text format.
+  "status": "A String", # [Output Only] The status of the operation, which can be one of the
+      # following:
+      # `PENDING`, `RUNNING`, or `DONE`.
+  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
+      # operation.
+  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
+      # of the target resource.
+  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
+      # operations related to creating a snapshot, this points to the disk
+      # that the snapshot was created from.
+  "user": "A String", # [Output Only] User who requested the operation, for example:
+      # `user@example.com` or
+      # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+  "warnings": [ # [Output Only] If warning messages are generated during processing of the
+      # operation, this field will be populated.
+    {
+      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+          # Engine returns NO_RESULTS_ON_PAGE if there
+          # are no results in the response.
+      "data": [ # [Output Only] Metadata about this warning in key:
+          # value format. For example:
+          #
+          # "data": [
+          #   {
+          #    "key": "scope",
+          #    "value": "zones/us-east1-d"
+          #   }
+        {
+          "key": "A String", # [Output Only] A key that provides more detail on the warning being
+              # returned. For example, for warnings where there are no results in a list
+              # request for a particular zone, this key might be scope and
+              # the key value might be the zone name. Other examples might be a key
+              # indicating a deprecated resource and a suggested replacement, or a
+              # warning about invalid network settings (for example, if an instance
+              # attempts to perform IP forwarding but is not enabled for IP forwarding).
+          "value": "A String", # [Output Only] A warning data value corresponding to the key.
+        },
+      ],
+      "message": "A String", # [Output Only] A human-readable description of the warning code.
+    },
+  ],
+  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
+      # applicable when performing per-zone operations.
+}
+
+ +
+ get(project, zone, instantSnapshotGroup, x__xgafv=None) +
returns the specified InstantSnapshotGroup resource in the specified zone.
+
+Args:
+  project: string, Project ID for this request. (required)
+  zone: string, The name of the zone for this request. (required)
+  instantSnapshotGroup: string, Name of the InstantSnapshotGroup resource to return. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an InstantSnapshotGroup resource.
+    #
+    # An instant snapshot group is a set of instant snapshots that represents a
+    # point in time state of a consistency group.
+  "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339
+      # text format.
+  "description": "A String", # Optional. An optional description of this resource. Provide this property when you
+      # create the resource.
+  "id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is
+      # defined by the server.
+  "kind": "compute#instantSnapshotGroup", # Output only. [Output Only] Type of the resource. Alwayscompute#instantSnapshotGroup for InstantSnapshotGroup
+      # resources.
+  "name": "A String", # Identifier. Name of the resource; provided by the client when the resource is created.
+      # The name must be 1-63 characters long, and comply withRFC1035.
+      # Specifically, the name must be 1-63 characters long and match the regular
+      # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
+      # character must be a lowercase letter, and all following characters must be
+      # a dash, lowercase letter, or digit, except the last character, which cannot
+      # be a dash.
+  "region": "A String", # Output only. [Output Only] URL of the region where the instant snapshot group resides.
+      # You must specify this field as part of the HTTP request URL. It is
+      # not settable as a field in the request body.
+  "resourceStatus": {
+    "consistencyMembershipResolutionTime": "A String", # Output only. [Output Only]
+    "sourceInfo": { # Output only. [Output Only]
+      "consistencyGroup": "A String",
+      "consistencyGroupId": "A String",
+    },
+  },
+  "selfLink": "A String", # Output only. [Output Only] Server-defined URL for the resource.
+  "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource's resource id.
+  "sourceConsistencyGroup": "A String",
+  "status": "A String", # Output only. [Output Only]
+  "zone": "A String", # Output only. [Output Only] URL of the zone where the instant snapshot group resides.
+      # You must specify this field as part of the HTTP request URL. It is
+      # not settable as a field in the request body.
+}
+
+ +
+ getIamPolicy(project, zone, resource, optionsRequestedPolicyVersion=None, x__xgafv=None) +
Gets the access control policy for a resource. May be empty if no such
+policy or resource exists.
+
+Args:
+  project: string, Project ID for this request. (required)
+  zone: string, The name of the zone for this request. (required)
+  resource: string, Name or id of the resource for this request. (required)
+  optionsRequestedPolicyVersion: integer, Requested IAM Policy version.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An Identity and Access Management (IAM) policy, which specifies access
+    # controls for Google Cloud resources.
+    #
+    #
+    # A `Policy` is a collection of `bindings`. A `binding` binds one or more
+    # `members`, or principals, to a single `role`. Principals can be user
+    # accounts, service accounts, Google groups, and domains (such as G Suite). A
+    # `role` is a named list of permissions; each `role` can be an IAM predefined
+    # role or a user-created custom role.
+    #
+    # For some types of Google Cloud resources, a `binding` can also specify a
+    # `condition`, which is a logical expression that allows access to a resource
+    # only if the expression evaluates to `true`. A condition can add constraints
+    # based on attributes of the request, the resource, or both. To learn which
+    # resources support conditions in their IAM policies, see the
+    # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+    #
+    # **JSON example:**
+    #
+    # ```
+    #     {
+    #       "bindings": [
+    #         {
+    #           "role": "roles/resourcemanager.organizationAdmin",
+    #           "members": [
+    #             "user:mike@example.com",
+    #             "group:admins@example.com",
+    #             "domain:google.com",
+    #             "serviceAccount:my-project-id@appspot.gserviceaccount.com"
+    #           ]
+    #         },
+    #         {
+    #           "role": "roles/resourcemanager.organizationViewer",
+    #           "members": [
+    #             "user:eve@example.com"
+    #           ],
+    #           "condition": {
+    #             "title": "expirable access",
+    #             "description": "Does not grant access after Sep 2020",
+    #             "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
+    #           }
+    #         }
+    #       ],
+    #       "etag": "BwWWja0YfJA=",
+    #       "version": 3
+    #     }
+    # ```
+    #
+    # **YAML example:**
+    #
+    # ```
+    #     bindings:
+    #     - members:
+    #       - user:mike@example.com
+    #       - group:admins@example.com
+    #       - domain:google.com
+    #       - serviceAccount:my-project-id@appspot.gserviceaccount.com
+    #       role: roles/resourcemanager.organizationAdmin
+    #     - members:
+    #       - user:eve@example.com
+    #       role: roles/resourcemanager.organizationViewer
+    #       condition:
+    #         title: expirable access
+    #         description: Does not grant access after Sep 2020
+    #         expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
+    #     etag: BwWWja0YfJA=
+    #     version: 3
+    # ```
+    #
+    # For a description of IAM and its features, see the
+    # [IAM documentation](https://cloud.google.com/iam/docs/).
+  "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+    { # Specifies the audit configuration for a service.
+        # The configuration determines which permission types are logged, and what
+        # identities, if any, are exempted from logging.
+        # An AuditConfig must have one or more AuditLogConfigs.
+        #
+        # If there are AuditConfigs for both `allServices` and a specific service,
+        # the union of the two AuditConfigs is used for that service: the log_types
+        # specified in each AuditConfig are enabled, and the exempted_members in each
+        # AuditLogConfig are exempted.
+        #
+        # Example Policy with multiple AuditConfigs:
+        #
+        #     {
+        #       "audit_configs": [
+        #         {
+        #           "service": "allServices",
+        #           "audit_log_configs": [
+        #             {
+        #               "log_type": "DATA_READ",
+        #               "exempted_members": [
+        #                 "user:jose@example.com"
+        #               ]
+        #             },
+        #             {
+        #               "log_type": "DATA_WRITE"
+        #             },
+        #             {
+        #               "log_type": "ADMIN_READ"
+        #             }
+        #           ]
+        #         },
+        #         {
+        #           "service": "sampleservice.googleapis.com",
+        #           "audit_log_configs": [
+        #             {
+        #               "log_type": "DATA_READ"
+        #             },
+        #             {
+        #               "log_type": "DATA_WRITE",
+        #               "exempted_members": [
+        #                 "user:aliya@example.com"
+        #               ]
+        #             }
+        #           ]
+        #         }
+        #       ]
+        #     }
+        #
+        # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
+        # logging. It also exempts `jose@example.com` from DATA_READ logging, and
+        # `aliya@example.com` from DATA_WRITE logging.
+      "auditLogConfigs": [ # The configuration for logging of each type of permission.
+        { # Provides the configuration for logging a type of permissions.
+            # Example:
+            #
+            #     {
+            #       "audit_log_configs": [
+            #         {
+            #           "log_type": "DATA_READ",
+            #           "exempted_members": [
+            #             "user:jose@example.com"
+            #           ]
+            #         },
+            #         {
+            #           "log_type": "DATA_WRITE"
+            #         }
+            #       ]
+            #     }
+            #
+            # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
+            # jose@example.com from DATA_READ logging.
+          "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
+              # permission.
+              # Follows the same format of Binding.members.
+            "A String",
+          ],
+          "logType": "A String", # The log type that this config enables.
+        },
+      ],
+      "service": "A String", # Specifies a service that will be enabled for audit logging.
+          # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
+          # `allServices` is a special value that covers all services.
+    },
+  ],
+  "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally,
+      # may specify a `condition` that determines how and when the `bindings` are
+      # applied. Each of the `bindings` must contain at least one principal.
+      #
+      # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
+      # of these principals can be Google groups. Each occurrence of a principal
+      # counts towards these limits. For example, if the `bindings` grant 50
+      # different roles to `user:alice@example.com`, and not to any other
+      # principal, then you can add another 1,450 principals to the `bindings` in
+      # the `Policy`.
+    { # Associates `members`, or principals, with a `role`.
+      "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
+          #
+          # If the condition evaluates to `true`, then this binding applies to the
+          # current request.
+          #
+          # If the condition evaluates to `false`, then this binding does not apply to
+          # the current request. However, a different role binding might grant the same
+          # role to one or more of the principals in this binding.
+          #
+          # To learn which resources support conditions in their IAM policies, see the
+          # [IAM
+          # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+          # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
+          # are documented at https://github.com/google/cel-spec.
+          #
+          # Example (Comparison):
+          #
+          #     title: "Summary size limit"
+          #     description: "Determines if a summary is less than 100 chars"
+          #     expression: "document.summary.size() < 100"
+          #
+          # Example (Equality):
+          #
+          #     title: "Requestor is owner"
+          #     description: "Determines if requestor is the document owner"
+          #     expression: "document.owner == request.auth.claims.email"
+          #
+          # Example (Logic):
+          #
+          #     title: "Public documents"
+          #     description: "Determine whether the document should be publicly visible"
+          #     expression: "document.type != 'private' && document.type != 'internal'"
+          #
+          # Example (Data Manipulation):
+          #
+          #     title: "Notification string"
+          #     description: "Create a notification string with a timestamp."
+          #     expression: "'New message received at ' + string(document.create_time)"
+          #
+          # The exact variables and functions that may be referenced within an expression
+          # are determined by the service that evaluates it. See the service
+          # documentation for additional information.
+        "description": "A String", # Optional. Description of the expression. This is a longer text which
+            # describes the expression, e.g. when hovered over it in a UI.
+        "expression": "A String", # Textual representation of an expression in Common Expression Language
+            # syntax.
+        "location": "A String", # Optional. String indicating the location of the expression for error
+            # reporting, e.g. a file name and a position in the file.
+        "title": "A String", # Optional. Title for the expression, i.e. a short string describing
+            # its purpose. This can be used e.g. in UIs which allow to enter the
+            # expression.
+      },
+      "members": [ # Specifies the principals requesting access for a Google Cloud resource.
+          # `members` can have the following values:
+          #
+          # * `allUsers`: A special identifier that represents anyone who is
+          #    on the internet; with or without a Google account.
+          #
+          # * `allAuthenticatedUsers`: A special identifier that represents anyone
+          #    who is authenticated with a Google account or a service account.
+          #    Does not include identities that come from external identity providers
+          #    (IdPs) through identity federation.
+          #
+          # * `user:{emailid}`: An email address that represents a specific Google
+          #    account. For example, `alice@example.com` .
+          #
+          #
+          # * `serviceAccount:{emailid}`: An email address that represents a Google
+          #    service account. For example,
+          #    `my-other-app@appspot.gserviceaccount.com`.
+          #
+          # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
+          #    identifier for a
+          #    [Kubernetes service
+          #    account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
+          #    For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
+          #
+          # * `group:{emailid}`: An email address that represents a Google group.
+          #    For example, `admins@example.com`.
+          #
+          #
+          # * `domain:{domain}`: The G Suite domain (primary) that represents all the
+          #    users of that domain. For example, `google.com` or `example.com`.
+          #
+          #
+          #
+          #
+          # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
+          #   A single identity in a workforce identity pool.
+          #
+          # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
+          #   All workforce identities in a group.
+          #
+          # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
+          #   All workforce identities with a specific attribute value.
+          #
+          # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
+          #   All identities in a workforce identity pool.
+          #
+          # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
+          #   A single identity in a workload identity pool.
+          #
+          # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
+          #   A workload identity pool group.
+          #
+          # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
+          #   All identities in a workload identity pool with a certain attribute.
+          #
+          # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
+          #   All identities in a workload identity pool.
+          #
+          # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
+          #    identifier) representing a user that has been recently deleted. For
+          #    example, `alice@example.com?uid=123456789012345678901`. If the user is
+          #    recovered, this value reverts to `user:{emailid}` and the recovered user
+          #    retains the role in the binding.
+          #
+          # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
+          #    unique identifier) representing a service account that has been recently
+          #    deleted. For example,
+          #    `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
+          #    If the service account is undeleted, this value reverts to
+          #    `serviceAccount:{emailid}` and the undeleted service account retains the
+          #    role in the binding.
+          #
+          # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
+          #    identifier) representing a Google group that has been recently
+          #    deleted. For example, `admins@example.com?uid=123456789012345678901`. If
+          #    the group is recovered, this value reverts to `group:{emailid}` and the
+          #    recovered group retains the role in the binding.
+          #
+          # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
+          #   Deleted single identity in a workforce identity pool. For example,
+          #   `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+        "A String",
+      ],
+      "role": "A String", # Role that is assigned to the list of `members`, or principals.
+          # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+          #
+          # For an overview of the IAM roles and permissions, see the
+          # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
+          # a list of the available pre-defined roles, see
+          # [here](https://cloud.google.com/iam/docs/understanding-roles).
+    },
+  ],
+  "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
+      # prevent simultaneous updates of a policy from overwriting each other.
+      # It is strongly suggested that systems make use of the `etag` in the
+      # read-modify-write cycle to perform policy updates in order to avoid race
+      # conditions: An `etag` is returned in the response to `getIamPolicy`, and
+      # systems are expected to put that etag in the request to `setIamPolicy` to
+      # ensure that their change will be applied to the same version of the policy.
+      #
+      # **Important:** If you use IAM Conditions, you must include the `etag` field
+      # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+      # you to overwrite a version `3` policy with a version `1` policy, and all of
+      # the conditions in the version `3` policy are lost.
+  "version": 42, # Specifies the format of the policy.
+      #
+      # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
+      # are rejected.
+      #
+      # Any operation that affects conditional role bindings must specify version
+      # `3`. This requirement applies to the following operations:
+      #
+      # * Getting a policy that includes a conditional role binding
+      # * Adding a conditional role binding to a policy
+      # * Changing a conditional role binding in a policy
+      # * Removing any role binding, with or without a condition, from a policy
+      #   that includes conditions
+      #
+      # **Important:** If you use IAM Conditions, you must include the `etag` field
+      # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+      # you to overwrite a version `3` policy with a version `1` policy, and all of
+      # the conditions in the version `3` policy are lost.
+      #
+      # If a policy does not include any conditions, operations on that policy may
+      # specify any valid version or leave the field unset.
+      #
+      # To learn which resources support conditions in their IAM policies, see the
+      # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+}
+
+ +
+ insert(project, zone, body=None, requestId=None, sourceConsistencyGroup=None, x__xgafv=None) +
inserts a Zonal InstantSnapshotGroup resource
+
+Args:
+  project: string, Project ID for this request. (required)
+  zone: string, Name of the zone for this request. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Represents an InstantSnapshotGroup resource.
+    # 
+    # An instant snapshot group is a set of instant snapshots that represents a
+    # point in time state of a consistency group.
+  "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339
+      # text format.
+  "description": "A String", # Optional. An optional description of this resource. Provide this property when you
+      # create the resource.
+  "id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is
+      # defined by the server.
+  "kind": "compute#instantSnapshotGroup", # Output only. [Output Only] Type of the resource. Alwayscompute#instantSnapshotGroup for InstantSnapshotGroup
+      # resources.
+  "name": "A String", # Identifier. Name of the resource; provided by the client when the resource is created.
+      # The name must be 1-63 characters long, and comply withRFC1035.
+      # Specifically, the name must be 1-63 characters long and match the regular
+      # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
+      # character must be a lowercase letter, and all following characters must be
+      # a dash, lowercase letter, or digit, except the last character, which cannot
+      # be a dash.
+  "region": "A String", # Output only. [Output Only] URL of the region where the instant snapshot group resides.
+      # You must specify this field as part of the HTTP request URL. It is
+      # not settable as a field in the request body.
+  "resourceStatus": {
+    "consistencyMembershipResolutionTime": "A String", # Output only. [Output Only]
+    "sourceInfo": { # Output only. [Output Only]
+      "consistencyGroup": "A String",
+      "consistencyGroupId": "A String",
+    },
+  },
+  "selfLink": "A String", # Output only. [Output Only] Server-defined URL for the resource.
+  "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource's resource id.
+  "sourceConsistencyGroup": "A String",
+  "status": "A String", # Output only. [Output Only]
+  "zone": "A String", # Output only. [Output Only] URL of the zone where the instant snapshot group resides.
+      # You must specify this field as part of the HTTP request URL. It is
+      # not settable as a field in the request body.
+}
+
+  requestId: string, An optional request ID to identify requests. Specify a unique request ID so
+that if you must retry your request, the server will know to ignore the
+request if it has already been completed.
+
+For example, consider a situation where you make an initial request and
+the request times out. If you make the request again with the same
+request ID, the server can check if original operation with the same
+request ID was received, and if so, will ignore the second request. This
+prevents clients from accidentally creating duplicate commitments.
+
+The request ID must be
+a valid UUID with the exception that zero UUID is not supported
+(00000000-0000-0000-0000-000000000000).
+  sourceConsistencyGroup: string, begin_interface: MixerMutationRequestBuilder
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an Operation resource.
+    #
+    # Google Compute Engine has three Operation resources:
+    #
+    # * [Global](/compute/docs/reference/rest/v1/globalOperations)
+    # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
+    # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
+    #
+    # You can use an operation resource to manage asynchronous API requests.
+    # For more information, readHandling
+    # API responses.
+    #
+    # Operations can be global, regional or zonal.
+    #
+    #    - For global operations, use the `globalOperations`
+    #    resource.
+    #    - For regional operations, use the
+    #    `regionOperations` resource.
+    #    - For zonal operations, use
+    #    the `zoneOperations` resource.
+    #
+    #
+    #
+    # For more information, read
+    # Global, Regional, and Zonal Resources.
+    #
+    # Note that completed Operation resources have a limited
+    # retention period.
+  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
+      # Not present otherwise.
+  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+  "description": "A String", # [Output Only] A textual description of the operation, which is
+      # set when the operation is created.
+  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
+      # text format.
+  "error": { # [Output Only] If errors are generated during processing of the operation,
+      # this field will be populated.
+    "errors": [ # [Output Only] The array of errors encountered while processing this
+        # operation.
+      {
+        "code": "A String", # [Output Only] The error type identifier for this error.
+        "errorDetails": [ # [Output Only] An optional list of messages that contain the error
+            # details. There is a set of defined message types to use for providing
+            # details.The syntax depends on the error code. For example,
+            # QuotaExceededInfo will have details when the error code is
+            # QUOTA_EXCEEDED.
+          {
+            "errorInfo": { # Describes the cause of the error with structured details.
+                #
+                # Example of an error when contacting the "pubsub.googleapis.com" API when it
+                # is not enabled:
+                #
+                #     { "reason": "API_DISABLED"
+                #       "domain": "googleapis.com"
+                #       "metadata": {
+                #         "resource": "projects/123",
+                #         "service": "pubsub.googleapis.com"
+                #       }
+                #     }
+                #
+                # This response indicates that the pubsub.googleapis.com API is not enabled.
+                #
+                # Example of an error that is returned when attempting to create a Spanner
+                # instance in a region that is out of stock:
+                #
+                #     { "reason": "STOCKOUT"
+                #       "domain": "spanner.googleapis.com",
+                #       "metadata": {
+                #         "availableRegions": "us-central1,us-east2"
+                #       }
+                #     }
+              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+                  # is typically the registered service name of the tool or product that
+                  # generates the error. Example: "pubsub.googleapis.com". If the error is
+                  # generated by some common infrastructure, the error domain must be a
+                  # globally unique value that identifies the infrastructure. For Google API
+                  # infrastructure, the error domain is "googleapis.com".
+              "metadatas": { # Additional structured details about this error.
+                  #
+                  # Keys must match a regular expression of `a-z+` but should
+                  # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+                  # length. When identifying the current value of an exceeded limit, the units
+                  # should be contained in the key, not the value.  For example, rather than
+                  # `{"instanceLimit": "100/request"}`, should be returned as,
+                  # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+                  # instances that can be created in a single (batch) request.
+                "a_key": "A String",
+              },
+              "reason": "A String", # The reason of the error. This is a constant value that identifies the
+                  # proximate cause of the error. Error reasons are unique within a particular
+                  # domain of errors. This should be at most 63 characters and match a
+                  # regular expression of `A-Z+[A-Z0-9]`, which represents
+                  # UPPER_SNAKE_CASE.
+            },
+            "help": { # Provides links to documentation or for performing an out of band action.
+                #
+                # For example, if a quota check failed with an error indicating the calling
+                # project hasn't enabled the accessed service, this can contain a URL pointing
+                # directly to the right place in the developer console to flip the bit.
+              "links": [ # URL(s) pointing to additional information on handling the current error.
+                { # Describes a URL link.
+                  "description": "A String", # Describes what the link offers.
+                  "url": "A String", # The URL of the link.
+                },
+              ],
+            },
+            "localizedMessage": { # Provides a localized error message that is safe to return to the user
+                # which can be attached to an RPC error.
+              "locale": "A String", # The locale used following the specification defined at
+                  # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+                  # Examples are: "en-US", "fr-CH", "es-MX"
+              "message": "A String", # The localized error message in the above locale.
+            },
+            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+              "dimensions": { # The map holding related quota dimensions.
+                "a_key": "A String",
+              },
+              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+                  #  type or metric.
+              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+                  # or metric.
+              "limitName": "A String", # The name of the quota limit.
+              "metricName": "A String", # The Compute Engine quota metric name.
+              "rolloutStatus": "A String", # Rollout status of the future quota limit.
+            },
+          },
+        ],
+        "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+            # This property is optional.
+        "message": "A String", # [Output Only] An optional, human-readable error message.
+      },
+    ],
+  },
+  "getVersionOperationMetadata": {
+    "inlineSbomInfo": {
+      "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+          # name and the value is the version.
+        "a_key": "A String",
+      },
+      "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+          # component name and the value is the version.
+        "a_key": "A String",
+      },
+    },
+  },
+  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
+      # message that was returned, such as `NOT FOUND`.
+  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
+      # status code that was returned. For example, a `404` means the
+      # resource was not found.
+  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
+      # defined by the server.
+  "insertTime": "A String", # [Output Only] The time that this operation was requested.
+      # This value is inRFC3339
+      # text format.
+  "instancesBulkInsertOperationMetadata": {
+    "perLocationStatus": { # Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
+            # error.
+        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
+            # if the flow is rolling forward or rolling back.
+        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+      },
+    },
+  },
+  "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
+      # Operation resources.
+  "name": "A String", # [Output Only] Name of the operation.
+  "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
+      # group of operations results from a `bulkInsert` API request.
+  "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
+      # `update`, or `delete`, and so on.
+  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
+      # There is no requirement that this be linear or support any granularity of
+      # operations. This should not be used to guess when the operation will be
+      # complete. This number should monotonically increase as the operation
+      # progresses.
+  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
+      # applicable when performing regional operations.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
+      # this field will contain information on all underlying zonal actions and
+      # their state.
+    "clientOperationId": "A String", # [Output Only] The client operation id.
+    "perLocationOperations": { # [Output Only] Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
+            # populated.
+            # different programming environments, including REST APIs and RPC APIs. It is
+            # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+            # three pieces of data: error code, error message, and error details.
+            #
+            # You can find out more about this error model and how to work with it in the
+            # [API Design Guide](https://cloud.google.com/apis/design/errors).
+          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+          "details": [ # A list of messages that carry the error details.  There is a common set of
+              # message types for APIs to use.
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+          "message": "A String", # A developer-facing error message, which should be in English. Any
+              # user-facing error message should be localized and sent in the
+              # google.rpc.Status.details field, or localized by the client.
+        },
+        "state": "A String", # [Output Only] Status of the action, which can be one of the following:
+            # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+      },
+    },
+  },
+  "startTime": "A String", # [Output Only] The time that this operation was started by the server.
+      # This value is inRFC3339
+      # text format.
+  "status": "A String", # [Output Only] The status of the operation, which can be one of the
+      # following:
+      # `PENDING`, `RUNNING`, or `DONE`.
+  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
+      # operation.
+  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
+      # of the target resource.
+  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
+      # operations related to creating a snapshot, this points to the disk
+      # that the snapshot was created from.
+  "user": "A String", # [Output Only] User who requested the operation, for example:
+      # `user@example.com` or
+      # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+  "warnings": [ # [Output Only] If warning messages are generated during processing of the
+      # operation, this field will be populated.
+    {
+      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+          # Engine returns NO_RESULTS_ON_PAGE if there
+          # are no results in the response.
+      "data": [ # [Output Only] Metadata about this warning in key:
+          # value format. For example:
+          #
+          # "data": [
+          #   {
+          #    "key": "scope",
+          #    "value": "zones/us-east1-d"
+          #   }
+        {
+          "key": "A String", # [Output Only] A key that provides more detail on the warning being
+              # returned. For example, for warnings where there are no results in a list
+              # request for a particular zone, this key might be scope and
+              # the key value might be the zone name. Other examples might be a key
+              # indicating a deprecated resource and a suggested replacement, or a
+              # warning about invalid network settings (for example, if an instance
+              # attempts to perform IP forwarding but is not enabled for IP forwarding).
+          "value": "A String", # [Output Only] A warning data value corresponding to the key.
+        },
+      ],
+      "message": "A String", # [Output Only] A human-readable description of the warning code.
+    },
+  ],
+  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
+      # applicable when performing per-zone operations.
+}
+
+ +
+ list(project, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) +
retrieves the list of InstantSnapshotGroup resources contained within
+the specified zone.
+
+Args:
+  project: string, Project ID for this request. (required)
+  zone: string, The name of the zone for this request. (required)
+  filter: string, A filter expression that filters resources listed in the response. Most
+Compute resources support two types of filter expressions:
+expressions that support regular expressions and expressions that follow
+API improvement proposal AIP-160.
+These two types of filter expressions cannot be mixed in one request.
+
+If you want to use AIP-160, your expression must specify the field name, an
+operator, and the value that you want to use for filtering. The value
+must be a string, a number, or a boolean. The operator
+must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.
+
+For example, if you are filtering Compute Engine instances, you can
+exclude instances named `example-instance` by specifying
+`name != example-instance`.
+
+The `:*` comparison can be used to test whether a key has been defined.
+For example, to find all objects with `owner` label use:
+```
+labels.owner:*
+```
+
+You can also filter nested fields. For example, you could specify
+`scheduling.automaticRestart = false` to include instances only
+if they are not scheduled for automatic restarts. You can use filtering
+on nested fields to filter based onresource labels.
+
+To filter on multiple expressions, provide each separate expression within
+parentheses. For example:
+```
+(scheduling.automaticRestart = true)
+(cpuPlatform = "Intel Skylake")
+```
+By default, each expression is an `AND` expression. However, you
+can include `AND` and `OR` expressions explicitly.
+For example:
+```
+(cpuPlatform = "Intel Skylake") OR
+(cpuPlatform = "Intel Broadwell") AND
+(scheduling.automaticRestart = true)
+```
+
+If you want to use a regular expression, use the `eq` (equal) or `ne`
+(not equal) operator against a single un-parenthesized expression with or
+without quotes or against multiple parenthesized expressions. Examples:
+
+`fieldname eq unquoted literal`
+`fieldname eq 'single quoted literal'`
+`fieldname eq "double quoted literal"`
+`(fieldname1 eq literal) (fieldname2 ne "literal")`
+
+The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
+The literal value must match the entire field.
+
+For example, to filter for instances that do not end with name "instance",
+you would use `name ne .*instance`.
+
+You cannot combine constraints on multiple fields using regular
+expressions.
+  maxResults: integer, The maximum number of results per page that should be returned.
+If the number of available results is larger than `maxResults`,
+Compute Engine returns a `nextPageToken` that can be used to get
+the next page of results in subsequent list requests. Acceptable values are
+`0` to `500`, inclusive. (Default: `500`)
+  orderBy: string, Sorts list results by a certain order. By default, results
+are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation
+timestamp using `orderBy="creationTimestamp desc"`. This sorts
+results based on the `creationTimestamp` field in
+reverse chronological order (newest result first). Use this to sort
+resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by `name` or
+`creationTimestamp desc` is supported.
+  pageToken: string, Specifies a page token to use. Set `pageToken` to the
+`nextPageToken` returned by a previous list request to get
+the next page of results.
+  returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
+of failure. The default value is false.
+
+For example, when partial success behavior is enabled, aggregatedList for a
+single zone scope either returns all resources in the zone or no resources,
+with an error code.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Contains a list of InstantSnapshotGroup resources.
+  "etag": "A String",
+  "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+  "items": [ # A list of InstantSnapshotGroup resources.
+    { # Represents an InstantSnapshotGroup resource.
+        #
+        # An instant snapshot group is a set of instant snapshots that represents a
+        # point in time state of a consistency group.
+      "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339
+          # text format.
+      "description": "A String", # Optional. An optional description of this resource. Provide this property when you
+          # create the resource.
+      "id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is
+          # defined by the server.
+      "kind": "compute#instantSnapshotGroup", # Output only. [Output Only] Type of the resource. Alwayscompute#instantSnapshotGroup for InstantSnapshotGroup
+          # resources.
+      "name": "A String", # Identifier. Name of the resource; provided by the client when the resource is created.
+          # The name must be 1-63 characters long, and comply withRFC1035.
+          # Specifically, the name must be 1-63 characters long and match the regular
+          # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
+          # character must be a lowercase letter, and all following characters must be
+          # a dash, lowercase letter, or digit, except the last character, which cannot
+          # be a dash.
+      "region": "A String", # Output only. [Output Only] URL of the region where the instant snapshot group resides.
+          # You must specify this field as part of the HTTP request URL. It is
+          # not settable as a field in the request body.
+      "resourceStatus": {
+        "consistencyMembershipResolutionTime": "A String", # Output only. [Output Only]
+        "sourceInfo": { # Output only. [Output Only]
+          "consistencyGroup": "A String",
+          "consistencyGroupId": "A String",
+        },
+      },
+      "selfLink": "A String", # Output only. [Output Only] Server-defined URL for the resource.
+      "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource's resource id.
+      "sourceConsistencyGroup": "A String",
+      "status": "A String", # Output only. [Output Only]
+      "zone": "A String", # Output only. [Output Only] URL of the zone where the instant snapshot group resides.
+          # You must specify this field as part of the HTTP request URL. It is
+          # not settable as a field in the request body.
+    },
+  ],
+  "kind": "compute#instantSnapshotGroupsList", # Output only. Type of resource.
+  "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for
+      # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
+      # the query parameter pageToken in the next list request.
+      # Subsequent list requests will have their own nextPageToken to
+      # continue paging through the results.
+  "selfLink": "A String", # Output only. [Output Only] Server-defined URL for this resource.
+  "unreachables": [ # Output only. [Output Only] Unreachable resources.
+      # end_interface: MixerListResponseWithEtagBuilder
+    "A String",
+  ],
+  "warning": { # [Output Only] Informational warning message.
+    "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+        # Engine returns NO_RESULTS_ON_PAGE if there
+        # are no results in the response.
+    "data": [ # [Output Only] Metadata about this warning in key:
+        # value format. For example:
+        #
+        # "data": [
+        #   {
+        #    "key": "scope",
+        #    "value": "zones/us-east1-d"
+        #   }
+      {
+        "key": "A String", # [Output Only] A key that provides more detail on the warning being
+            # returned. For example, for warnings where there are no results in a list
+            # request for a particular zone, this key might be scope and
+            # the key value might be the zone name. Other examples might be a key
+            # indicating a deprecated resource and a suggested replacement, or a
+            # warning about invalid network settings (for example, if an instance
+            # attempts to perform IP forwarding but is not enabled for IP forwarding).
+        "value": "A String", # [Output Only] A warning data value corresponding to the key.
+      },
+    ],
+    "message": "A String", # [Output Only] A human-readable description of the warning code.
+  },
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ setIamPolicy(project, zone, resource, body=None, x__xgafv=None) +
Sets the access control policy on the specified resource.
+Replaces any existing policy.
+
+Args:
+  project: string, Project ID for this request. (required)
+  zone: string, The name of the zone for this request. (required)
+  resource: string, Name or id of the resource for this request. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{
+  "bindings": [ # Flatten Policy to create a backwacd compatible wire-format.
+      # Deprecated. Use 'policy' to specify bindings.
+    { # Associates `members`, or principals, with a `role`.
+      "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
+          #
+          # If the condition evaluates to `true`, then this binding applies to the
+          # current request.
+          #
+          # If the condition evaluates to `false`, then this binding does not apply to
+          # the current request. However, a different role binding might grant the same
+          # role to one or more of the principals in this binding.
+          #
+          # To learn which resources support conditions in their IAM policies, see the
+          # [IAM
+          # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+          # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
+          # are documented at https://github.com/google/cel-spec.
+          #
+          # Example (Comparison):
+          #
+          #     title: "Summary size limit"
+          #     description: "Determines if a summary is less than 100 chars"
+          #     expression: "document.summary.size() < 100"
+          #
+          # Example (Equality):
+          #
+          #     title: "Requestor is owner"
+          #     description: "Determines if requestor is the document owner"
+          #     expression: "document.owner == request.auth.claims.email"
+          #
+          # Example (Logic):
+          #
+          #     title: "Public documents"
+          #     description: "Determine whether the document should be publicly visible"
+          #     expression: "document.type != 'private' && document.type != 'internal'"
+          #
+          # Example (Data Manipulation):
+          #
+          #     title: "Notification string"
+          #     description: "Create a notification string with a timestamp."
+          #     expression: "'New message received at ' + string(document.create_time)"
+          #
+          # The exact variables and functions that may be referenced within an expression
+          # are determined by the service that evaluates it. See the service
+          # documentation for additional information.
+        "description": "A String", # Optional. Description of the expression. This is a longer text which
+            # describes the expression, e.g. when hovered over it in a UI.
+        "expression": "A String", # Textual representation of an expression in Common Expression Language
+            # syntax.
+        "location": "A String", # Optional. String indicating the location of the expression for error
+            # reporting, e.g. a file name and a position in the file.
+        "title": "A String", # Optional. Title for the expression, i.e. a short string describing
+            # its purpose. This can be used e.g. in UIs which allow to enter the
+            # expression.
+      },
+      "members": [ # Specifies the principals requesting access for a Google Cloud resource.
+          # `members` can have the following values:
+          #
+          # * `allUsers`: A special identifier that represents anyone who is
+          #    on the internet; with or without a Google account.
+          #
+          # * `allAuthenticatedUsers`: A special identifier that represents anyone
+          #    who is authenticated with a Google account or a service account.
+          #    Does not include identities that come from external identity providers
+          #    (IdPs) through identity federation.
+          #
+          # * `user:{emailid}`: An email address that represents a specific Google
+          #    account. For example, `alice@example.com` .
+          #
+          #
+          # * `serviceAccount:{emailid}`: An email address that represents a Google
+          #    service account. For example,
+          #    `my-other-app@appspot.gserviceaccount.com`.
+          #
+          # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
+          #    identifier for a
+          #    [Kubernetes service
+          #    account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
+          #    For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
+          #
+          # * `group:{emailid}`: An email address that represents a Google group.
+          #    For example, `admins@example.com`.
+          #
+          #
+          # * `domain:{domain}`: The G Suite domain (primary) that represents all the
+          #    users of that domain. For example, `google.com` or `example.com`.
+          #
+          #
+          #
+          #
+          # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
+          #   A single identity in a workforce identity pool.
+          #
+          # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
+          #   All workforce identities in a group.
+          #
+          # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
+          #   All workforce identities with a specific attribute value.
+          #
+          # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
+          #   All identities in a workforce identity pool.
+          #
+          # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
+          #   A single identity in a workload identity pool.
+          #
+          # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
+          #   A workload identity pool group.
+          #
+          # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
+          #   All identities in a workload identity pool with a certain attribute.
+          #
+          # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
+          #   All identities in a workload identity pool.
+          #
+          # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
+          #    identifier) representing a user that has been recently deleted. For
+          #    example, `alice@example.com?uid=123456789012345678901`. If the user is
+          #    recovered, this value reverts to `user:{emailid}` and the recovered user
+          #    retains the role in the binding.
+          #
+          # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
+          #    unique identifier) representing a service account that has been recently
+          #    deleted. For example,
+          #    `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
+          #    If the service account is undeleted, this value reverts to
+          #    `serviceAccount:{emailid}` and the undeleted service account retains the
+          #    role in the binding.
+          #
+          # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
+          #    identifier) representing a Google group that has been recently
+          #    deleted. For example, `admins@example.com?uid=123456789012345678901`. If
+          #    the group is recovered, this value reverts to `group:{emailid}` and the
+          #    recovered group retains the role in the binding.
+          #
+          # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
+          #   Deleted single identity in a workforce identity pool. For example,
+          #   `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+        "A String",
+      ],
+      "role": "A String", # Role that is assigned to the list of `members`, or principals.
+          # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+          #
+          # For an overview of the IAM roles and permissions, see the
+          # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
+          # a list of the available pre-defined roles, see
+          # [here](https://cloud.google.com/iam/docs/understanding-roles).
+    },
+  ],
+  "etag": "A String", # Flatten Policy to create a backward compatible wire-format.
+      # Deprecated. Use 'policy' to specify the etag.
+  "policy": { # An Identity and Access Management (IAM) policy, which specifies access # REQUIRED: The complete policy to be applied to the 'resource'. The size of
+      # the policy is limited to a few 10s of KB. An empty policy is in general a
+      # valid policy but certain services (like Projects) might reject them.
+      # controls for Google Cloud resources.
+      #
+      #
+      # A `Policy` is a collection of `bindings`. A `binding` binds one or more
+      # `members`, or principals, to a single `role`. Principals can be user
+      # accounts, service accounts, Google groups, and domains (such as G Suite). A
+      # `role` is a named list of permissions; each `role` can be an IAM predefined
+      # role or a user-created custom role.
+      #
+      # For some types of Google Cloud resources, a `binding` can also specify a
+      # `condition`, which is a logical expression that allows access to a resource
+      # only if the expression evaluates to `true`. A condition can add constraints
+      # based on attributes of the request, the resource, or both. To learn which
+      # resources support conditions in their IAM policies, see the
+      # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+      #
+      # **JSON example:**
+      #
+      # ```
+      #     {
+      #       "bindings": [
+      #         {
+      #           "role": "roles/resourcemanager.organizationAdmin",
+      #           "members": [
+      #             "user:mike@example.com",
+      #             "group:admins@example.com",
+      #             "domain:google.com",
+      #             "serviceAccount:my-project-id@appspot.gserviceaccount.com"
+      #           ]
+      #         },
+      #         {
+      #           "role": "roles/resourcemanager.organizationViewer",
+      #           "members": [
+      #             "user:eve@example.com"
+      #           ],
+      #           "condition": {
+      #             "title": "expirable access",
+      #             "description": "Does not grant access after Sep 2020",
+      #             "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
+      #           }
+      #         }
+      #       ],
+      #       "etag": "BwWWja0YfJA=",
+      #       "version": 3
+      #     }
+      # ```
+      #
+      # **YAML example:**
+      #
+      # ```
+      #     bindings:
+      #     - members:
+      #       - user:mike@example.com
+      #       - group:admins@example.com
+      #       - domain:google.com
+      #       - serviceAccount:my-project-id@appspot.gserviceaccount.com
+      #       role: roles/resourcemanager.organizationAdmin
+      #     - members:
+      #       - user:eve@example.com
+      #       role: roles/resourcemanager.organizationViewer
+      #       condition:
+      #         title: expirable access
+      #         description: Does not grant access after Sep 2020
+      #         expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
+      #     etag: BwWWja0YfJA=
+      #     version: 3
+      # ```
+      #
+      # For a description of IAM and its features, see the
+      # [IAM documentation](https://cloud.google.com/iam/docs/).
+    "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+      { # Specifies the audit configuration for a service.
+          # The configuration determines which permission types are logged, and what
+          # identities, if any, are exempted from logging.
+          # An AuditConfig must have one or more AuditLogConfigs.
+          #
+          # If there are AuditConfigs for both `allServices` and a specific service,
+          # the union of the two AuditConfigs is used for that service: the log_types
+          # specified in each AuditConfig are enabled, and the exempted_members in each
+          # AuditLogConfig are exempted.
+          #
+          # Example Policy with multiple AuditConfigs:
+          #
+          #     {
+          #       "audit_configs": [
+          #         {
+          #           "service": "allServices",
+          #           "audit_log_configs": [
+          #             {
+          #               "log_type": "DATA_READ",
+          #               "exempted_members": [
+          #                 "user:jose@example.com"
+          #               ]
+          #             },
+          #             {
+          #               "log_type": "DATA_WRITE"
+          #             },
+          #             {
+          #               "log_type": "ADMIN_READ"
+          #             }
+          #           ]
+          #         },
+          #         {
+          #           "service": "sampleservice.googleapis.com",
+          #           "audit_log_configs": [
+          #             {
+          #               "log_type": "DATA_READ"
+          #             },
+          #             {
+          #               "log_type": "DATA_WRITE",
+          #               "exempted_members": [
+          #                 "user:aliya@example.com"
+          #               ]
+          #             }
+          #           ]
+          #         }
+          #       ]
+          #     }
+          #
+          # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
+          # logging. It also exempts `jose@example.com` from DATA_READ logging, and
+          # `aliya@example.com` from DATA_WRITE logging.
+        "auditLogConfigs": [ # The configuration for logging of each type of permission.
+          { # Provides the configuration for logging a type of permissions.
+              # Example:
+              #
+              #     {
+              #       "audit_log_configs": [
+              #         {
+              #           "log_type": "DATA_READ",
+              #           "exempted_members": [
+              #             "user:jose@example.com"
+              #           ]
+              #         },
+              #         {
+              #           "log_type": "DATA_WRITE"
+              #         }
+              #       ]
+              #     }
+              #
+              # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
+              # jose@example.com from DATA_READ logging.
+            "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
+                # permission.
+                # Follows the same format of Binding.members.
+              "A String",
+            ],
+            "logType": "A String", # The log type that this config enables.
+          },
+        ],
+        "service": "A String", # Specifies a service that will be enabled for audit logging.
+            # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
+            # `allServices` is a special value that covers all services.
+      },
+    ],
+    "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally,
+        # may specify a `condition` that determines how and when the `bindings` are
+        # applied. Each of the `bindings` must contain at least one principal.
+        #
+        # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
+        # of these principals can be Google groups. Each occurrence of a principal
+        # counts towards these limits. For example, if the `bindings` grant 50
+        # different roles to `user:alice@example.com`, and not to any other
+        # principal, then you can add another 1,450 principals to the `bindings` in
+        # the `Policy`.
+      { # Associates `members`, or principals, with a `role`.
+        "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
+            #
+            # If the condition evaluates to `true`, then this binding applies to the
+            # current request.
+            #
+            # If the condition evaluates to `false`, then this binding does not apply to
+            # the current request. However, a different role binding might grant the same
+            # role to one or more of the principals in this binding.
+            #
+            # To learn which resources support conditions in their IAM policies, see the
+            # [IAM
+            # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+            # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
+            # are documented at https://github.com/google/cel-spec.
+            #
+            # Example (Comparison):
+            #
+            #     title: "Summary size limit"
+            #     description: "Determines if a summary is less than 100 chars"
+            #     expression: "document.summary.size() < 100"
+            #
+            # Example (Equality):
+            #
+            #     title: "Requestor is owner"
+            #     description: "Determines if requestor is the document owner"
+            #     expression: "document.owner == request.auth.claims.email"
+            #
+            # Example (Logic):
+            #
+            #     title: "Public documents"
+            #     description: "Determine whether the document should be publicly visible"
+            #     expression: "document.type != 'private' && document.type != 'internal'"
+            #
+            # Example (Data Manipulation):
+            #
+            #     title: "Notification string"
+            #     description: "Create a notification string with a timestamp."
+            #     expression: "'New message received at ' + string(document.create_time)"
+            #
+            # The exact variables and functions that may be referenced within an expression
+            # are determined by the service that evaluates it. See the service
+            # documentation for additional information.
+          "description": "A String", # Optional. Description of the expression. This is a longer text which
+              # describes the expression, e.g. when hovered over it in a UI.
+          "expression": "A String", # Textual representation of an expression in Common Expression Language
+              # syntax.
+          "location": "A String", # Optional. String indicating the location of the expression for error
+              # reporting, e.g. a file name and a position in the file.
+          "title": "A String", # Optional. Title for the expression, i.e. a short string describing
+              # its purpose. This can be used e.g. in UIs which allow to enter the
+              # expression.
+        },
+        "members": [ # Specifies the principals requesting access for a Google Cloud resource.
+            # `members` can have the following values:
+            #
+            # * `allUsers`: A special identifier that represents anyone who is
+            #    on the internet; with or without a Google account.
+            #
+            # * `allAuthenticatedUsers`: A special identifier that represents anyone
+            #    who is authenticated with a Google account or a service account.
+            #    Does not include identities that come from external identity providers
+            #    (IdPs) through identity federation.
+            #
+            # * `user:{emailid}`: An email address that represents a specific Google
+            #    account. For example, `alice@example.com` .
+            #
+            #
+            # * `serviceAccount:{emailid}`: An email address that represents a Google
+            #    service account. For example,
+            #    `my-other-app@appspot.gserviceaccount.com`.
+            #
+            # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
+            #    identifier for a
+            #    [Kubernetes service
+            #    account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
+            #    For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
+            #
+            # * `group:{emailid}`: An email address that represents a Google group.
+            #    For example, `admins@example.com`.
+            #
+            #
+            # * `domain:{domain}`: The G Suite domain (primary) that represents all the
+            #    users of that domain. For example, `google.com` or `example.com`.
+            #
+            #
+            #
+            #
+            # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
+            #   A single identity in a workforce identity pool.
+            #
+            # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
+            #   All workforce identities in a group.
+            #
+            # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
+            #   All workforce identities with a specific attribute value.
+            #
+            # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
+            #   All identities in a workforce identity pool.
+            #
+            # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
+            #   A single identity in a workload identity pool.
+            #
+            # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
+            #   A workload identity pool group.
+            #
+            # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
+            #   All identities in a workload identity pool with a certain attribute.
+            #
+            # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
+            #   All identities in a workload identity pool.
+            #
+            # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
+            #    identifier) representing a user that has been recently deleted. For
+            #    example, `alice@example.com?uid=123456789012345678901`. If the user is
+            #    recovered, this value reverts to `user:{emailid}` and the recovered user
+            #    retains the role in the binding.
+            #
+            # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
+            #    unique identifier) representing a service account that has been recently
+            #    deleted. For example,
+            #    `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
+            #    If the service account is undeleted, this value reverts to
+            #    `serviceAccount:{emailid}` and the undeleted service account retains the
+            #    role in the binding.
+            #
+            # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
+            #    identifier) representing a Google group that has been recently
+            #    deleted. For example, `admins@example.com?uid=123456789012345678901`. If
+            #    the group is recovered, this value reverts to `group:{emailid}` and the
+            #    recovered group retains the role in the binding.
+            #
+            # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
+            #   Deleted single identity in a workforce identity pool. For example,
+            #   `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+          "A String",
+        ],
+        "role": "A String", # Role that is assigned to the list of `members`, or principals.
+            # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+            #
+            # For an overview of the IAM roles and permissions, see the
+            # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
+            # a list of the available pre-defined roles, see
+            # [here](https://cloud.google.com/iam/docs/understanding-roles).
+      },
+    ],
+    "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
+        # prevent simultaneous updates of a policy from overwriting each other.
+        # It is strongly suggested that systems make use of the `etag` in the
+        # read-modify-write cycle to perform policy updates in order to avoid race
+        # conditions: An `etag` is returned in the response to `getIamPolicy`, and
+        # systems are expected to put that etag in the request to `setIamPolicy` to
+        # ensure that their change will be applied to the same version of the policy.
+        #
+        # **Important:** If you use IAM Conditions, you must include the `etag` field
+        # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+        # you to overwrite a version `3` policy with a version `1` policy, and all of
+        # the conditions in the version `3` policy are lost.
+    "version": 42, # Specifies the format of the policy.
+        #
+        # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
+        # are rejected.
+        #
+        # Any operation that affects conditional role bindings must specify version
+        # `3`. This requirement applies to the following operations:
+        #
+        # * Getting a policy that includes a conditional role binding
+        # * Adding a conditional role binding to a policy
+        # * Changing a conditional role binding in a policy
+        # * Removing any role binding, with or without a condition, from a policy
+        #   that includes conditions
+        #
+        # **Important:** If you use IAM Conditions, you must include the `etag` field
+        # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+        # you to overwrite a version `3` policy with a version `1` policy, and all of
+        # the conditions in the version `3` policy are lost.
+        #
+        # If a policy does not include any conditions, operations on that policy may
+        # specify any valid version or leave the field unset.
+        #
+        # To learn which resources support conditions in their IAM policies, see the
+        # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An Identity and Access Management (IAM) policy, which specifies access
+    # controls for Google Cloud resources.
+    #
+    #
+    # A `Policy` is a collection of `bindings`. A `binding` binds one or more
+    # `members`, or principals, to a single `role`. Principals can be user
+    # accounts, service accounts, Google groups, and domains (such as G Suite). A
+    # `role` is a named list of permissions; each `role` can be an IAM predefined
+    # role or a user-created custom role.
+    #
+    # For some types of Google Cloud resources, a `binding` can also specify a
+    # `condition`, which is a logical expression that allows access to a resource
+    # only if the expression evaluates to `true`. A condition can add constraints
+    # based on attributes of the request, the resource, or both. To learn which
+    # resources support conditions in their IAM policies, see the
+    # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+    #
+    # **JSON example:**
+    #
+    # ```
+    #     {
+    #       "bindings": [
+    #         {
+    #           "role": "roles/resourcemanager.organizationAdmin",
+    #           "members": [
+    #             "user:mike@example.com",
+    #             "group:admins@example.com",
+    #             "domain:google.com",
+    #             "serviceAccount:my-project-id@appspot.gserviceaccount.com"
+    #           ]
+    #         },
+    #         {
+    #           "role": "roles/resourcemanager.organizationViewer",
+    #           "members": [
+    #             "user:eve@example.com"
+    #           ],
+    #           "condition": {
+    #             "title": "expirable access",
+    #             "description": "Does not grant access after Sep 2020",
+    #             "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
+    #           }
+    #         }
+    #       ],
+    #       "etag": "BwWWja0YfJA=",
+    #       "version": 3
+    #     }
+    # ```
+    #
+    # **YAML example:**
+    #
+    # ```
+    #     bindings:
+    #     - members:
+    #       - user:mike@example.com
+    #       - group:admins@example.com
+    #       - domain:google.com
+    #       - serviceAccount:my-project-id@appspot.gserviceaccount.com
+    #       role: roles/resourcemanager.organizationAdmin
+    #     - members:
+    #       - user:eve@example.com
+    #       role: roles/resourcemanager.organizationViewer
+    #       condition:
+    #         title: expirable access
+    #         description: Does not grant access after Sep 2020
+    #         expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
+    #     etag: BwWWja0YfJA=
+    #     version: 3
+    # ```
+    #
+    # For a description of IAM and its features, see the
+    # [IAM documentation](https://cloud.google.com/iam/docs/).
+  "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+    { # Specifies the audit configuration for a service.
+        # The configuration determines which permission types are logged, and what
+        # identities, if any, are exempted from logging.
+        # An AuditConfig must have one or more AuditLogConfigs.
+        #
+        # If there are AuditConfigs for both `allServices` and a specific service,
+        # the union of the two AuditConfigs is used for that service: the log_types
+        # specified in each AuditConfig are enabled, and the exempted_members in each
+        # AuditLogConfig are exempted.
+        #
+        # Example Policy with multiple AuditConfigs:
+        #
+        #     {
+        #       "audit_configs": [
+        #         {
+        #           "service": "allServices",
+        #           "audit_log_configs": [
+        #             {
+        #               "log_type": "DATA_READ",
+        #               "exempted_members": [
+        #                 "user:jose@example.com"
+        #               ]
+        #             },
+        #             {
+        #               "log_type": "DATA_WRITE"
+        #             },
+        #             {
+        #               "log_type": "ADMIN_READ"
+        #             }
+        #           ]
+        #         },
+        #         {
+        #           "service": "sampleservice.googleapis.com",
+        #           "audit_log_configs": [
+        #             {
+        #               "log_type": "DATA_READ"
+        #             },
+        #             {
+        #               "log_type": "DATA_WRITE",
+        #               "exempted_members": [
+        #                 "user:aliya@example.com"
+        #               ]
+        #             }
+        #           ]
+        #         }
+        #       ]
+        #     }
+        #
+        # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
+        # logging. It also exempts `jose@example.com` from DATA_READ logging, and
+        # `aliya@example.com` from DATA_WRITE logging.
+      "auditLogConfigs": [ # The configuration for logging of each type of permission.
+        { # Provides the configuration for logging a type of permissions.
+            # Example:
+            #
+            #     {
+            #       "audit_log_configs": [
+            #         {
+            #           "log_type": "DATA_READ",
+            #           "exempted_members": [
+            #             "user:jose@example.com"
+            #           ]
+            #         },
+            #         {
+            #           "log_type": "DATA_WRITE"
+            #         }
+            #       ]
+            #     }
+            #
+            # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
+            # jose@example.com from DATA_READ logging.
+          "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
+              # permission.
+              # Follows the same format of Binding.members.
+            "A String",
+          ],
+          "logType": "A String", # The log type that this config enables.
+        },
+      ],
+      "service": "A String", # Specifies a service that will be enabled for audit logging.
+          # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
+          # `allServices` is a special value that covers all services.
+    },
+  ],
+  "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally,
+      # may specify a `condition` that determines how and when the `bindings` are
+      # applied. Each of the `bindings` must contain at least one principal.
+      #
+      # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
+      # of these principals can be Google groups. Each occurrence of a principal
+      # counts towards these limits. For example, if the `bindings` grant 50
+      # different roles to `user:alice@example.com`, and not to any other
+      # principal, then you can add another 1,450 principals to the `bindings` in
+      # the `Policy`.
+    { # Associates `members`, or principals, with a `role`.
+      "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
+          #
+          # If the condition evaluates to `true`, then this binding applies to the
+          # current request.
+          #
+          # If the condition evaluates to `false`, then this binding does not apply to
+          # the current request. However, a different role binding might grant the same
+          # role to one or more of the principals in this binding.
+          #
+          # To learn which resources support conditions in their IAM policies, see the
+          # [IAM
+          # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+          # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
+          # are documented at https://github.com/google/cel-spec.
+          #
+          # Example (Comparison):
+          #
+          #     title: "Summary size limit"
+          #     description: "Determines if a summary is less than 100 chars"
+          #     expression: "document.summary.size() < 100"
+          #
+          # Example (Equality):
+          #
+          #     title: "Requestor is owner"
+          #     description: "Determines if requestor is the document owner"
+          #     expression: "document.owner == request.auth.claims.email"
+          #
+          # Example (Logic):
+          #
+          #     title: "Public documents"
+          #     description: "Determine whether the document should be publicly visible"
+          #     expression: "document.type != 'private' && document.type != 'internal'"
+          #
+          # Example (Data Manipulation):
+          #
+          #     title: "Notification string"
+          #     description: "Create a notification string with a timestamp."
+          #     expression: "'New message received at ' + string(document.create_time)"
+          #
+          # The exact variables and functions that may be referenced within an expression
+          # are determined by the service that evaluates it. See the service
+          # documentation for additional information.
+        "description": "A String", # Optional. Description of the expression. This is a longer text which
+            # describes the expression, e.g. when hovered over it in a UI.
+        "expression": "A String", # Textual representation of an expression in Common Expression Language
+            # syntax.
+        "location": "A String", # Optional. String indicating the location of the expression for error
+            # reporting, e.g. a file name and a position in the file.
+        "title": "A String", # Optional. Title for the expression, i.e. a short string describing
+            # its purpose. This can be used e.g. in UIs which allow to enter the
+            # expression.
+      },
+      "members": [ # Specifies the principals requesting access for a Google Cloud resource.
+          # `members` can have the following values:
+          #
+          # * `allUsers`: A special identifier that represents anyone who is
+          #    on the internet; with or without a Google account.
+          #
+          # * `allAuthenticatedUsers`: A special identifier that represents anyone
+          #    who is authenticated with a Google account or a service account.
+          #    Does not include identities that come from external identity providers
+          #    (IdPs) through identity federation.
+          #
+          # * `user:{emailid}`: An email address that represents a specific Google
+          #    account. For example, `alice@example.com` .
+          #
+          #
+          # * `serviceAccount:{emailid}`: An email address that represents a Google
+          #    service account. For example,
+          #    `my-other-app@appspot.gserviceaccount.com`.
+          #
+          # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
+          #    identifier for a
+          #    [Kubernetes service
+          #    account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
+          #    For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
+          #
+          # * `group:{emailid}`: An email address that represents a Google group.
+          #    For example, `admins@example.com`.
+          #
+          #
+          # * `domain:{domain}`: The G Suite domain (primary) that represents all the
+          #    users of that domain. For example, `google.com` or `example.com`.
+          #
+          #
+          #
+          #
+          # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
+          #   A single identity in a workforce identity pool.
+          #
+          # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
+          #   All workforce identities in a group.
+          #
+          # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
+          #   All workforce identities with a specific attribute value.
+          #
+          # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
+          #   All identities in a workforce identity pool.
+          #
+          # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
+          #   A single identity in a workload identity pool.
+          #
+          # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
+          #   A workload identity pool group.
+          #
+          # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
+          #   All identities in a workload identity pool with a certain attribute.
+          #
+          # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
+          #   All identities in a workload identity pool.
+          #
+          # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
+          #    identifier) representing a user that has been recently deleted. For
+          #    example, `alice@example.com?uid=123456789012345678901`. If the user is
+          #    recovered, this value reverts to `user:{emailid}` and the recovered user
+          #    retains the role in the binding.
+          #
+          # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
+          #    unique identifier) representing a service account that has been recently
+          #    deleted. For example,
+          #    `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
+          #    If the service account is undeleted, this value reverts to
+          #    `serviceAccount:{emailid}` and the undeleted service account retains the
+          #    role in the binding.
+          #
+          # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
+          #    identifier) representing a Google group that has been recently
+          #    deleted. For example, `admins@example.com?uid=123456789012345678901`. If
+          #    the group is recovered, this value reverts to `group:{emailid}` and the
+          #    recovered group retains the role in the binding.
+          #
+          # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
+          #   Deleted single identity in a workforce identity pool. For example,
+          #   `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+        "A String",
+      ],
+      "role": "A String", # Role that is assigned to the list of `members`, or principals.
+          # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+          #
+          # For an overview of the IAM roles and permissions, see the
+          # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
+          # a list of the available pre-defined roles, see
+          # [here](https://cloud.google.com/iam/docs/understanding-roles).
+    },
+  ],
+  "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
+      # prevent simultaneous updates of a policy from overwriting each other.
+      # It is strongly suggested that systems make use of the `etag` in the
+      # read-modify-write cycle to perform policy updates in order to avoid race
+      # conditions: An `etag` is returned in the response to `getIamPolicy`, and
+      # systems are expected to put that etag in the request to `setIamPolicy` to
+      # ensure that their change will be applied to the same version of the policy.
+      #
+      # **Important:** If you use IAM Conditions, you must include the `etag` field
+      # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+      # you to overwrite a version `3` policy with a version `1` policy, and all of
+      # the conditions in the version `3` policy are lost.
+  "version": 42, # Specifies the format of the policy.
+      #
+      # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
+      # are rejected.
+      #
+      # Any operation that affects conditional role bindings must specify version
+      # `3`. This requirement applies to the following operations:
+      #
+      # * Getting a policy that includes a conditional role binding
+      # * Adding a conditional role binding to a policy
+      # * Changing a conditional role binding in a policy
+      # * Removing any role binding, with or without a condition, from a policy
+      #   that includes conditions
+      #
+      # **Important:** If you use IAM Conditions, you must include the `etag` field
+      # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+      # you to overwrite a version `3` policy with a version `1` policy, and all of
+      # the conditions in the version `3` policy are lost.
+      #
+      # If a policy does not include any conditions, operations on that policy may
+      # specify any valid version or leave the field unset.
+      #
+      # To learn which resources support conditions in their IAM policies, see the
+      # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+}
+
+ +
+ testIamPermissions(project, zone, resource, body=None, x__xgafv=None) +
Returns permissions that a caller has on the specified resource.
+
+Args:
+  project: string, Project ID for this request. (required)
+  zone: string, The name of the zone for this request. (required)
+  resource: string, Name or id of the resource for this request. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{
+  "permissions": [ # The set of permissions to check for the 'resource'. Permissions with
+      # wildcards (such as '*' or 'storage.*') are not allowed.
+    "A String",
+  ],
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is
+      # allowed.
+    "A String",
+  ],
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/compute_v1.instantSnapshots.html b/docs/dyn/compute_v1.instantSnapshots.html index 90e9747dd6..8d9f5ec9c7 100644 --- a/docs/dyn/compute_v1.instantSnapshots.html +++ b/docs/dyn/compute_v1.instantSnapshots.html @@ -307,6 +307,13 @@

Method Details

"sourceDiskId": "A String", # Output only. [Output Only] The ID value of the disk used to create this InstantSnapshot. # This value may be used to determine whether the InstantSnapshot # was taken from the current or a previous instance of a given disk name. + "sourceInstantSnapshotGroup": "A String", # Output only. [Output Only] URL of the source instant snapshot this instant snapshot is + # part of. Note that the source instant snapshot group must be in the same + # zone/region as the instant snapshot to be created. This can be a full or + # valid partial URL. + "sourceInstantSnapshotGroupId": "A String", # Output only. [Output Only] The ID value of the source instant snapshot group this + # InstantSnapshot is part of. This value may be used to determine whether the + # InstantSnapshot was created as part of an InstantSnapshotGroup creation. "status": "A String", # Output only. [Output Only] The status of the instantSnapshot. This can beCREATING, DELETING, FAILED, orREADY. "zone": "A String", # Output only. [Output Only] URL of the zone where the instant snapshot resides. # You must specify this field as part of the HTTP request URL. It is @@ -797,6 +804,13 @@

Method Details

"sourceDiskId": "A String", # Output only. [Output Only] The ID value of the disk used to create this InstantSnapshot. # This value may be used to determine whether the InstantSnapshot # was taken from the current or a previous instance of a given disk name. + "sourceInstantSnapshotGroup": "A String", # Output only. [Output Only] URL of the source instant snapshot this instant snapshot is + # part of. Note that the source instant snapshot group must be in the same + # zone/region as the instant snapshot to be created. This can be a full or + # valid partial URL. + "sourceInstantSnapshotGroupId": "A String", # Output only. [Output Only] The ID value of the source instant snapshot group this + # InstantSnapshot is part of. This value may be used to determine whether the + # InstantSnapshot was created as part of an InstantSnapshotGroup creation. "status": "A String", # Output only. [Output Only] The status of the instantSnapshot. This can beCREATING, DELETING, FAILED, orREADY. "zone": "A String", # Output only. [Output Only] URL of the zone where the instant snapshot resides. # You must specify this field as part of the HTTP request URL. It is @@ -1265,6 +1279,13 @@

Method Details

"sourceDiskId": "A String", # Output only. [Output Only] The ID value of the disk used to create this InstantSnapshot. # This value may be used to determine whether the InstantSnapshot # was taken from the current or a previous instance of a given disk name. + "sourceInstantSnapshotGroup": "A String", # Output only. [Output Only] URL of the source instant snapshot this instant snapshot is + # part of. Note that the source instant snapshot group must be in the same + # zone/region as the instant snapshot to be created. This can be a full or + # valid partial URL. + "sourceInstantSnapshotGroupId": "A String", # Output only. [Output Only] The ID value of the source instant snapshot group this + # InstantSnapshot is part of. This value may be used to determine whether the + # InstantSnapshot was created as part of an InstantSnapshotGroup creation. "status": "A String", # Output only. [Output Only] The status of the instantSnapshot. This can beCREATING, DELETING, FAILED, orREADY. "zone": "A String", # Output only. [Output Only] URL of the zone where the instant snapshot resides. # You must specify this field as part of the HTTP request URL. It is @@ -1740,6 +1761,13 @@

Method Details

"sourceDiskId": "A String", # Output only. [Output Only] The ID value of the disk used to create this InstantSnapshot. # This value may be used to determine whether the InstantSnapshot # was taken from the current or a previous instance of a given disk name. + "sourceInstantSnapshotGroup": "A String", # Output only. [Output Only] URL of the source instant snapshot this instant snapshot is + # part of. Note that the source instant snapshot group must be in the same + # zone/region as the instant snapshot to be created. This can be a full or + # valid partial URL. + "sourceInstantSnapshotGroupId": "A String", # Output only. [Output Only] The ID value of the source instant snapshot group this + # InstantSnapshot is part of. This value may be used to determine whether the + # InstantSnapshot was created as part of an InstantSnapshotGroup creation. "status": "A String", # Output only. [Output Only] The status of the instantSnapshot. This can beCREATING, DELETING, FAILED, orREADY. "zone": "A String", # Output only. [Output Only] URL of the zone where the instant snapshot resides. # You must specify this field as part of the HTTP request URL. It is diff --git a/docs/dyn/compute_v1.machineImages.html b/docs/dyn/compute_v1.machineImages.html index 9822b32b68..e965f02e61 100644 --- a/docs/dyn/compute_v1.machineImages.html +++ b/docs/dyn/compute_v1.machineImages.html @@ -1144,15 +1144,6 @@

Method Details

"networkPerformanceConfig": { # Note that for MachineImage, this is not supported yet. "totalEgressBandwidthTier": "A String", }, - "partnerMetadata": { # Partner Metadata assigned to the instance properties. A map from a - # subdomain (namespace) to entries map. - "a_key": { - "entries": { # Map of a partner metadata that belong to the same subdomain. - # It accepts any value including google.protobuf.Struct. - "a_key": "", - }, - }, - }, "privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for VMs. # If not specified, use INHERIT_FROM_SUBNETWORK as default. # Note that for MachineImage, this is not supported yet. @@ -3090,15 +3081,6 @@

Method Details

"networkPerformanceConfig": { # Note that for MachineImage, this is not supported yet. "totalEgressBandwidthTier": "A String", }, - "partnerMetadata": { # Partner Metadata assigned to the instance properties. A map from a - # subdomain (namespace) to entries map. - "a_key": { - "entries": { # Map of a partner metadata that belong to the same subdomain. - # It accepts any value including google.protobuf.Struct. - "a_key": "", - }, - }, - }, "privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for VMs. # If not specified, use INHERIT_FROM_SUBNETWORK as default. # Note that for MachineImage, this is not supported yet. @@ -5041,15 +5023,6 @@

Method Details

"networkPerformanceConfig": { # Note that for MachineImage, this is not supported yet. "totalEgressBandwidthTier": "A String", }, - "partnerMetadata": { # Partner Metadata assigned to the instance properties. A map from a - # subdomain (namespace) to entries map. - "a_key": { - "entries": { # Map of a partner metadata that belong to the same subdomain. - # It accepts any value including google.protobuf.Struct. - "a_key": "", - }, - }, - }, "privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for VMs. # If not specified, use INHERIT_FROM_SUBNETWORK as default. # Note that for MachineImage, this is not supported yet. diff --git a/docs/dyn/compute_v1.regionDisks.html b/docs/dyn/compute_v1.regionDisks.html index 9a1ef6bd95..14266d03e7 100644 --- a/docs/dyn/compute_v1.regionDisks.html +++ b/docs/dyn/compute_v1.regionDisks.html @@ -452,6 +452,34 @@

Method Details

{ # A transient resource used in compute.disks.bulkInsert and # compute.regionDisks.bulkInsert. It is only used to process # requests and is not persisted. + "instantSnapshotGroupParameters": { # The parameters for the instant snapshot group. + "sourceInstantSnapshotGroup": "A String", # The source instant snapshot group used to create disks. You can provide + # this as a partial or full URL to the resource. For example, the following + # are valid values: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instantSnapshotGroups/instantSnapshotGroup + # - projects/project/zones/zone/instantSnapshotGroups/instantSnapshotGroup + # - zones/zone/instantSnapshotGroups/instantSnapshotGroup + }, + "snapshotGroupParameters": { # The parameters for the snapshot group. The usage of snapshot group feature + # is restricted. + "replicaZones": [ # URLs of the zones where disks should be replicated to. Only applicable + # for regional resources. + "A String", + ], + "sourceSnapshotGroup": "A String", # The source snapshot group used to create disks. You can provide this as a + # partial or full URL to the resource. For example, the following are valid + # values: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/global/snapshotGroups/snapshotGroup + # - projects/project/global/snapshotGroups/snapshotGroup + # - global/snapshotGroups/snapshotGroup + "type": "A String", # URL of the disk type resource describing which disk type to use to create + # disks. Provide this when creating the disk. For example:projects/project/zones/zone/diskTypes/pd-ssd. See Persistent disk + # types. + }, "sourceConsistencyGroupPolicy": "A String", # The URL of the DiskConsistencyGroupPolicy for the group of disks to clone. # This may be a full or partial URL, such as: # @@ -872,6 +900,8 @@

Method Details

"a_key": "A String", }, }, + "region": "A String", # Output only. [Output Only] URL of the region where the snapshot resides. Only applicable + # for regional snapshots. "satisfiesPzi": True or False, # Output only. Reserved for future use. "satisfiesPzs": True or False, # Output only. [Output Only] Reserved for future use. "selfLink": "A String", # Output only. [Output Only] Server-defined URL for the resource. @@ -940,6 +970,10 @@

Method Details

# 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, + "snapshotGroupId": "A String", # Output only. [Output Only] The unique ID of the snapshot group that this snapshot + # belongs to. The usage of snapshot group feature is restricted. + "snapshotGroupName": "A String", # Output only. [Output only] The snapshot group that this snapshot belongs to. The usage + # of snapshot group feature is restricted. "snapshotType": "A String", # Indicates the type of the snapshot. "sourceDisk": "A String", # The source disk used to create this snapshot. "sourceDiskEncryptionKey": { # The customer-supplied diff --git a/docs/dyn/compute_v1.regionInstanceTemplates.html b/docs/dyn/compute_v1.regionInstanceTemplates.html index 28b3ae08e1..486a3cfbe6 100644 --- a/docs/dyn/compute_v1.regionInstanceTemplates.html +++ b/docs/dyn/compute_v1.regionInstanceTemplates.html @@ -81,13 +81,13 @@

Instance Methods

delete(project, region, instanceTemplate, requestId=None, x__xgafv=None)

Deletes the specified instance template. Deleting an instance template is

- get(project, region, instanceTemplate, view=None, x__xgafv=None)

+ get(project, region, instanceTemplate, x__xgafv=None)

Returns the specified instance template.

insert(project, region, body=None, requestId=None, x__xgafv=None)

Creates an instance template in the specified project and region using the

- list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, view=None, x__xgafv=None)

+ list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Retrieves a list of instance templates that are contained within the

list_next()

@@ -393,18 +393,13 @@

Method Details

- get(project, region, instanceTemplate, view=None, x__xgafv=None) + get(project, region, instanceTemplate, x__xgafv=None)
Returns the specified instance template.
 
 Args:
   project: string, Project ID for this request. (required)
   region: string, The name of the region for this request. (required)
   instanceTemplate: string, The name of the instance template. (required)
-  view: string, View of the instance template.
-    Allowed values
-      BASIC - Include everything except Partner Metadata.
-      FULL - Include everything.
-      INSTANCE_VIEW_UNSPECIFIED - The default / unset value. The API will default to the BASIC view.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -1156,15 +1151,6 @@ 

Method Details

"networkPerformanceConfig": { # Note that for MachineImage, this is not supported yet. "totalEgressBandwidthTier": "A String", }, - "partnerMetadata": { # Partner Metadata assigned to the instance properties. A map from a - # subdomain (namespace) to entries map. - "a_key": { - "entries": { # Map of a partner metadata that belong to the same subdomain. - # It accepts any value including google.protobuf.Struct. - "a_key": "", - }, - }, - }, "privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for VMs. # If not specified, use INHERIT_FROM_SUBNETWORK as default. # Note that for MachineImage, this is not supported yet. @@ -2121,15 +2107,6 @@

Method Details

"networkPerformanceConfig": { # Note that for MachineImage, this is not supported yet. "totalEgressBandwidthTier": "A String", }, - "partnerMetadata": { # Partner Metadata assigned to the instance properties. A map from a - # subdomain (namespace) to entries map. - "a_key": { - "entries": { # Map of a partner metadata that belong to the same subdomain. - # It accepts any value including google.protobuf.Struct. - "a_key": "", - }, - }, - }, "privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for VMs. # If not specified, use INHERIT_FROM_SUBNETWORK as default. # Note that for MachineImage, this is not supported yet. @@ -2617,7 +2594,7 @@

Method Details

- list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, view=None, x__xgafv=None) + list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Retrieves a list of instance templates that are contained within the
 specified project and region.
 
@@ -2707,11 +2684,6 @@ 

Method Details

For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - view: string, View of the instance template. - Allowed values - BASIC - Include everything except Partner Metadata. - FULL - Include everything. - INSTANCE_VIEW_UNSPECIFIED - The default / unset value. The API will default to the BASIC view. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -3466,15 +3438,6 @@

Method Details

"networkPerformanceConfig": { # Note that for MachineImage, this is not supported yet. "totalEgressBandwidthTier": "A String", }, - "partnerMetadata": { # Partner Metadata assigned to the instance properties. A map from a - # subdomain (namespace) to entries map. - "a_key": { - "entries": { # Map of a partner metadata that belong to the same subdomain. - # It accepts any value including google.protobuf.Struct. - "a_key": "", - }, - }, - }, "privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for VMs. # If not specified, use INHERIT_FROM_SUBNETWORK as default. # Note that for MachineImage, this is not supported yet. diff --git a/docs/dyn/compute_v1.regionInstances.html b/docs/dyn/compute_v1.regionInstances.html index 75d19c8836..8f07832af1 100644 --- a/docs/dyn/compute_v1.regionInstances.html +++ b/docs/dyn/compute_v1.regionInstances.html @@ -1269,15 +1269,6 @@

Method Details

"networkPerformanceConfig": { # Note that for MachineImage, this is not supported yet. "totalEgressBandwidthTier": "A String", }, - "partnerMetadata": { # Partner Metadata assigned to the instance properties. A map from a - # subdomain (namespace) to entries map. - "a_key": { - "entries": { # Map of a partner metadata that belong to the same subdomain. - # It accepts any value including google.protobuf.Struct. - "a_key": "", - }, - }, - }, "privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for VMs. # If not specified, use INHERIT_FROM_SUBNETWORK as default. # Note that for MachineImage, this is not supported yet. diff --git a/docs/dyn/compute_v1.regionInstantSnapshotGroups.html b/docs/dyn/compute_v1.regionInstantSnapshotGroups.html new file mode 100644 index 0000000000..d4ecb72509 --- /dev/null +++ b/docs/dyn/compute_v1.regionInstantSnapshotGroups.html @@ -0,0 +1,2265 @@ + + + +

Compute Engine API . regionInstantSnapshotGroups

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ delete(project, region, instantSnapshotGroup, requestId=None, x__xgafv=None)

+

deletes a Regional InstantSnapshotGroup resource

+

+ get(project, region, instantSnapshotGroup, x__xgafv=None)

+

returns the specified InstantSnapshotGroup resource in the specified

+

+ getIamPolicy(project, region, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)

+

Gets the access control policy for a resource. May be empty if no such

+

+ insert(project, region, body=None, requestId=None, sourceConsistencyGroup=None, x__xgafv=None)

+

creates a Regional InstantSnapshotGroup resource

+

+ list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

retrieves the list of InstantSnapshotGroup resources contained within

+

+ list_next()

+

Retrieves the next page of results.

+

+ setIamPolicy(project, region, resource, body=None, x__xgafv=None)

+

Sets the access control policy on the specified resource.

+

+ testIamPermissions(project, region, resource, body=None, x__xgafv=None)

+

Returns permissions that a caller has on the specified resource.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ delete(project, region, instantSnapshotGroup, requestId=None, x__xgafv=None) +
deletes a Regional InstantSnapshotGroup resource
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, The name of the region for this request. (required)
+  instantSnapshotGroup: string, Name of the InstantSnapshotGroup resource to delete. (required)
+  requestId: string, An optional request ID to identify requests. Specify a unique request ID so
+that if you must retry your request, the server will know to ignore the
+request if it has already been completed.
+
+For example, consider a situation where you make an initial request and
+the request times out. If you make the request again with the same
+request ID, the server can check if original operation with the same
+request ID was received, and if so, will ignore the second request. This
+prevents clients from accidentally creating duplicate commitments.
+
+The request ID must be
+a valid UUID with the exception that zero UUID is not supported
+(00000000-0000-0000-0000-000000000000).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an Operation resource.
+    #
+    # Google Compute Engine has three Operation resources:
+    #
+    # * [Global](/compute/docs/reference/rest/v1/globalOperations)
+    # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
+    # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
+    #
+    # You can use an operation resource to manage asynchronous API requests.
+    # For more information, readHandling
+    # API responses.
+    #
+    # Operations can be global, regional or zonal.
+    #
+    #    - For global operations, use the `globalOperations`
+    #    resource.
+    #    - For regional operations, use the
+    #    `regionOperations` resource.
+    #    - For zonal operations, use
+    #    the `zoneOperations` resource.
+    #
+    #
+    #
+    # For more information, read
+    # Global, Regional, and Zonal Resources.
+    #
+    # Note that completed Operation resources have a limited
+    # retention period.
+  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
+      # Not present otherwise.
+  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+  "description": "A String", # [Output Only] A textual description of the operation, which is
+      # set when the operation is created.
+  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
+      # text format.
+  "error": { # [Output Only] If errors are generated during processing of the operation,
+      # this field will be populated.
+    "errors": [ # [Output Only] The array of errors encountered while processing this
+        # operation.
+      {
+        "code": "A String", # [Output Only] The error type identifier for this error.
+        "errorDetails": [ # [Output Only] An optional list of messages that contain the error
+            # details. There is a set of defined message types to use for providing
+            # details.The syntax depends on the error code. For example,
+            # QuotaExceededInfo will have details when the error code is
+            # QUOTA_EXCEEDED.
+          {
+            "errorInfo": { # Describes the cause of the error with structured details.
+                #
+                # Example of an error when contacting the "pubsub.googleapis.com" API when it
+                # is not enabled:
+                #
+                #     { "reason": "API_DISABLED"
+                #       "domain": "googleapis.com"
+                #       "metadata": {
+                #         "resource": "projects/123",
+                #         "service": "pubsub.googleapis.com"
+                #       }
+                #     }
+                #
+                # This response indicates that the pubsub.googleapis.com API is not enabled.
+                #
+                # Example of an error that is returned when attempting to create a Spanner
+                # instance in a region that is out of stock:
+                #
+                #     { "reason": "STOCKOUT"
+                #       "domain": "spanner.googleapis.com",
+                #       "metadata": {
+                #         "availableRegions": "us-central1,us-east2"
+                #       }
+                #     }
+              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+                  # is typically the registered service name of the tool or product that
+                  # generates the error. Example: "pubsub.googleapis.com". If the error is
+                  # generated by some common infrastructure, the error domain must be a
+                  # globally unique value that identifies the infrastructure. For Google API
+                  # infrastructure, the error domain is "googleapis.com".
+              "metadatas": { # Additional structured details about this error.
+                  #
+                  # Keys must match a regular expression of `a-z+` but should
+                  # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+                  # length. When identifying the current value of an exceeded limit, the units
+                  # should be contained in the key, not the value.  For example, rather than
+                  # `{"instanceLimit": "100/request"}`, should be returned as,
+                  # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+                  # instances that can be created in a single (batch) request.
+                "a_key": "A String",
+              },
+              "reason": "A String", # The reason of the error. This is a constant value that identifies the
+                  # proximate cause of the error. Error reasons are unique within a particular
+                  # domain of errors. This should be at most 63 characters and match a
+                  # regular expression of `A-Z+[A-Z0-9]`, which represents
+                  # UPPER_SNAKE_CASE.
+            },
+            "help": { # Provides links to documentation or for performing an out of band action.
+                #
+                # For example, if a quota check failed with an error indicating the calling
+                # project hasn't enabled the accessed service, this can contain a URL pointing
+                # directly to the right place in the developer console to flip the bit.
+              "links": [ # URL(s) pointing to additional information on handling the current error.
+                { # Describes a URL link.
+                  "description": "A String", # Describes what the link offers.
+                  "url": "A String", # The URL of the link.
+                },
+              ],
+            },
+            "localizedMessage": { # Provides a localized error message that is safe to return to the user
+                # which can be attached to an RPC error.
+              "locale": "A String", # The locale used following the specification defined at
+                  # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+                  # Examples are: "en-US", "fr-CH", "es-MX"
+              "message": "A String", # The localized error message in the above locale.
+            },
+            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+              "dimensions": { # The map holding related quota dimensions.
+                "a_key": "A String",
+              },
+              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+                  #  type or metric.
+              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+                  # or metric.
+              "limitName": "A String", # The name of the quota limit.
+              "metricName": "A String", # The Compute Engine quota metric name.
+              "rolloutStatus": "A String", # Rollout status of the future quota limit.
+            },
+          },
+        ],
+        "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+            # This property is optional.
+        "message": "A String", # [Output Only] An optional, human-readable error message.
+      },
+    ],
+  },
+  "getVersionOperationMetadata": {
+    "inlineSbomInfo": {
+      "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+          # name and the value is the version.
+        "a_key": "A String",
+      },
+      "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+          # component name and the value is the version.
+        "a_key": "A String",
+      },
+    },
+  },
+  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
+      # message that was returned, such as `NOT FOUND`.
+  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
+      # status code that was returned. For example, a `404` means the
+      # resource was not found.
+  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
+      # defined by the server.
+  "insertTime": "A String", # [Output Only] The time that this operation was requested.
+      # This value is inRFC3339
+      # text format.
+  "instancesBulkInsertOperationMetadata": {
+    "perLocationStatus": { # Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
+            # error.
+        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
+            # if the flow is rolling forward or rolling back.
+        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+      },
+    },
+  },
+  "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
+      # Operation resources.
+  "name": "A String", # [Output Only] Name of the operation.
+  "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
+      # group of operations results from a `bulkInsert` API request.
+  "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
+      # `update`, or `delete`, and so on.
+  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
+      # There is no requirement that this be linear or support any granularity of
+      # operations. This should not be used to guess when the operation will be
+      # complete. This number should monotonically increase as the operation
+      # progresses.
+  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
+      # applicable when performing regional operations.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
+      # this field will contain information on all underlying zonal actions and
+      # their state.
+    "clientOperationId": "A String", # [Output Only] The client operation id.
+    "perLocationOperations": { # [Output Only] Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
+            # populated.
+            # different programming environments, including REST APIs and RPC APIs. It is
+            # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+            # three pieces of data: error code, error message, and error details.
+            #
+            # You can find out more about this error model and how to work with it in the
+            # [API Design Guide](https://cloud.google.com/apis/design/errors).
+          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+          "details": [ # A list of messages that carry the error details.  There is a common set of
+              # message types for APIs to use.
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+          "message": "A String", # A developer-facing error message, which should be in English. Any
+              # user-facing error message should be localized and sent in the
+              # google.rpc.Status.details field, or localized by the client.
+        },
+        "state": "A String", # [Output Only] Status of the action, which can be one of the following:
+            # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+      },
+    },
+  },
+  "startTime": "A String", # [Output Only] The time that this operation was started by the server.
+      # This value is inRFC3339
+      # text format.
+  "status": "A String", # [Output Only] The status of the operation, which can be one of the
+      # following:
+      # `PENDING`, `RUNNING`, or `DONE`.
+  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
+      # operation.
+  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
+      # of the target resource.
+  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
+      # operations related to creating a snapshot, this points to the disk
+      # that the snapshot was created from.
+  "user": "A String", # [Output Only] User who requested the operation, for example:
+      # `user@example.com` or
+      # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+  "warnings": [ # [Output Only] If warning messages are generated during processing of the
+      # operation, this field will be populated.
+    {
+      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+          # Engine returns NO_RESULTS_ON_PAGE if there
+          # are no results in the response.
+      "data": [ # [Output Only] Metadata about this warning in key:
+          # value format. For example:
+          #
+          # "data": [
+          #   {
+          #    "key": "scope",
+          #    "value": "zones/us-east1-d"
+          #   }
+        {
+          "key": "A String", # [Output Only] A key that provides more detail on the warning being
+              # returned. For example, for warnings where there are no results in a list
+              # request for a particular zone, this key might be scope and
+              # the key value might be the zone name. Other examples might be a key
+              # indicating a deprecated resource and a suggested replacement, or a
+              # warning about invalid network settings (for example, if an instance
+              # attempts to perform IP forwarding but is not enabled for IP forwarding).
+          "value": "A String", # [Output Only] A warning data value corresponding to the key.
+        },
+      ],
+      "message": "A String", # [Output Only] A human-readable description of the warning code.
+    },
+  ],
+  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
+      # applicable when performing per-zone operations.
+}
+
+ +
+ get(project, region, instantSnapshotGroup, x__xgafv=None) +
returns the specified InstantSnapshotGroup resource in the specified
+region.
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, The name of the region for this request. (required)
+  instantSnapshotGroup: string, Name of the InstantSnapshotGroup resource to return. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an InstantSnapshotGroup resource.
+    #
+    # An instant snapshot group is a set of instant snapshots that represents a
+    # point in time state of a consistency group.
+  "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339
+      # text format.
+  "description": "A String", # Optional. An optional description of this resource. Provide this property when you
+      # create the resource.
+  "id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is
+      # defined by the server.
+  "kind": "compute#instantSnapshotGroup", # Output only. [Output Only] Type of the resource. Alwayscompute#instantSnapshotGroup for InstantSnapshotGroup
+      # resources.
+  "name": "A String", # Identifier. Name of the resource; provided by the client when the resource is created.
+      # The name must be 1-63 characters long, and comply withRFC1035.
+      # Specifically, the name must be 1-63 characters long and match the regular
+      # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
+      # character must be a lowercase letter, and all following characters must be
+      # a dash, lowercase letter, or digit, except the last character, which cannot
+      # be a dash.
+  "region": "A String", # Output only. [Output Only] URL of the region where the instant snapshot group resides.
+      # You must specify this field as part of the HTTP request URL. It is
+      # not settable as a field in the request body.
+  "resourceStatus": {
+    "consistencyMembershipResolutionTime": "A String", # Output only. [Output Only]
+    "sourceInfo": { # Output only. [Output Only]
+      "consistencyGroup": "A String",
+      "consistencyGroupId": "A String",
+    },
+  },
+  "selfLink": "A String", # Output only. [Output Only] Server-defined URL for the resource.
+  "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource's resource id.
+  "sourceConsistencyGroup": "A String",
+  "status": "A String", # Output only. [Output Only]
+  "zone": "A String", # Output only. [Output Only] URL of the zone where the instant snapshot group resides.
+      # You must specify this field as part of the HTTP request URL. It is
+      # not settable as a field in the request body.
+}
+
+ +
+ getIamPolicy(project, region, resource, optionsRequestedPolicyVersion=None, x__xgafv=None) +
Gets the access control policy for a resource. May be empty if no such
+policy or resource exists.
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, The name of the region for this request. (required)
+  resource: string, Name or id of the resource for this request. (required)
+  optionsRequestedPolicyVersion: integer, Requested IAM Policy version.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An Identity and Access Management (IAM) policy, which specifies access
+    # controls for Google Cloud resources.
+    #
+    #
+    # A `Policy` is a collection of `bindings`. A `binding` binds one or more
+    # `members`, or principals, to a single `role`. Principals can be user
+    # accounts, service accounts, Google groups, and domains (such as G Suite). A
+    # `role` is a named list of permissions; each `role` can be an IAM predefined
+    # role or a user-created custom role.
+    #
+    # For some types of Google Cloud resources, a `binding` can also specify a
+    # `condition`, which is a logical expression that allows access to a resource
+    # only if the expression evaluates to `true`. A condition can add constraints
+    # based on attributes of the request, the resource, or both. To learn which
+    # resources support conditions in their IAM policies, see the
+    # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+    #
+    # **JSON example:**
+    #
+    # ```
+    #     {
+    #       "bindings": [
+    #         {
+    #           "role": "roles/resourcemanager.organizationAdmin",
+    #           "members": [
+    #             "user:mike@example.com",
+    #             "group:admins@example.com",
+    #             "domain:google.com",
+    #             "serviceAccount:my-project-id@appspot.gserviceaccount.com"
+    #           ]
+    #         },
+    #         {
+    #           "role": "roles/resourcemanager.organizationViewer",
+    #           "members": [
+    #             "user:eve@example.com"
+    #           ],
+    #           "condition": {
+    #             "title": "expirable access",
+    #             "description": "Does not grant access after Sep 2020",
+    #             "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
+    #           }
+    #         }
+    #       ],
+    #       "etag": "BwWWja0YfJA=",
+    #       "version": 3
+    #     }
+    # ```
+    #
+    # **YAML example:**
+    #
+    # ```
+    #     bindings:
+    #     - members:
+    #       - user:mike@example.com
+    #       - group:admins@example.com
+    #       - domain:google.com
+    #       - serviceAccount:my-project-id@appspot.gserviceaccount.com
+    #       role: roles/resourcemanager.organizationAdmin
+    #     - members:
+    #       - user:eve@example.com
+    #       role: roles/resourcemanager.organizationViewer
+    #       condition:
+    #         title: expirable access
+    #         description: Does not grant access after Sep 2020
+    #         expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
+    #     etag: BwWWja0YfJA=
+    #     version: 3
+    # ```
+    #
+    # For a description of IAM and its features, see the
+    # [IAM documentation](https://cloud.google.com/iam/docs/).
+  "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+    { # Specifies the audit configuration for a service.
+        # The configuration determines which permission types are logged, and what
+        # identities, if any, are exempted from logging.
+        # An AuditConfig must have one or more AuditLogConfigs.
+        #
+        # If there are AuditConfigs for both `allServices` and a specific service,
+        # the union of the two AuditConfigs is used for that service: the log_types
+        # specified in each AuditConfig are enabled, and the exempted_members in each
+        # AuditLogConfig are exempted.
+        #
+        # Example Policy with multiple AuditConfigs:
+        #
+        #     {
+        #       "audit_configs": [
+        #         {
+        #           "service": "allServices",
+        #           "audit_log_configs": [
+        #             {
+        #               "log_type": "DATA_READ",
+        #               "exempted_members": [
+        #                 "user:jose@example.com"
+        #               ]
+        #             },
+        #             {
+        #               "log_type": "DATA_WRITE"
+        #             },
+        #             {
+        #               "log_type": "ADMIN_READ"
+        #             }
+        #           ]
+        #         },
+        #         {
+        #           "service": "sampleservice.googleapis.com",
+        #           "audit_log_configs": [
+        #             {
+        #               "log_type": "DATA_READ"
+        #             },
+        #             {
+        #               "log_type": "DATA_WRITE",
+        #               "exempted_members": [
+        #                 "user:aliya@example.com"
+        #               ]
+        #             }
+        #           ]
+        #         }
+        #       ]
+        #     }
+        #
+        # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
+        # logging. It also exempts `jose@example.com` from DATA_READ logging, and
+        # `aliya@example.com` from DATA_WRITE logging.
+      "auditLogConfigs": [ # The configuration for logging of each type of permission.
+        { # Provides the configuration for logging a type of permissions.
+            # Example:
+            #
+            #     {
+            #       "audit_log_configs": [
+            #         {
+            #           "log_type": "DATA_READ",
+            #           "exempted_members": [
+            #             "user:jose@example.com"
+            #           ]
+            #         },
+            #         {
+            #           "log_type": "DATA_WRITE"
+            #         }
+            #       ]
+            #     }
+            #
+            # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
+            # jose@example.com from DATA_READ logging.
+          "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
+              # permission.
+              # Follows the same format of Binding.members.
+            "A String",
+          ],
+          "logType": "A String", # The log type that this config enables.
+        },
+      ],
+      "service": "A String", # Specifies a service that will be enabled for audit logging.
+          # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
+          # `allServices` is a special value that covers all services.
+    },
+  ],
+  "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally,
+      # may specify a `condition` that determines how and when the `bindings` are
+      # applied. Each of the `bindings` must contain at least one principal.
+      #
+      # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
+      # of these principals can be Google groups. Each occurrence of a principal
+      # counts towards these limits. For example, if the `bindings` grant 50
+      # different roles to `user:alice@example.com`, and not to any other
+      # principal, then you can add another 1,450 principals to the `bindings` in
+      # the `Policy`.
+    { # Associates `members`, or principals, with a `role`.
+      "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
+          #
+          # If the condition evaluates to `true`, then this binding applies to the
+          # current request.
+          #
+          # If the condition evaluates to `false`, then this binding does not apply to
+          # the current request. However, a different role binding might grant the same
+          # role to one or more of the principals in this binding.
+          #
+          # To learn which resources support conditions in their IAM policies, see the
+          # [IAM
+          # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+          # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
+          # are documented at https://github.com/google/cel-spec.
+          #
+          # Example (Comparison):
+          #
+          #     title: "Summary size limit"
+          #     description: "Determines if a summary is less than 100 chars"
+          #     expression: "document.summary.size() < 100"
+          #
+          # Example (Equality):
+          #
+          #     title: "Requestor is owner"
+          #     description: "Determines if requestor is the document owner"
+          #     expression: "document.owner == request.auth.claims.email"
+          #
+          # Example (Logic):
+          #
+          #     title: "Public documents"
+          #     description: "Determine whether the document should be publicly visible"
+          #     expression: "document.type != 'private' && document.type != 'internal'"
+          #
+          # Example (Data Manipulation):
+          #
+          #     title: "Notification string"
+          #     description: "Create a notification string with a timestamp."
+          #     expression: "'New message received at ' + string(document.create_time)"
+          #
+          # The exact variables and functions that may be referenced within an expression
+          # are determined by the service that evaluates it. See the service
+          # documentation for additional information.
+        "description": "A String", # Optional. Description of the expression. This is a longer text which
+            # describes the expression, e.g. when hovered over it in a UI.
+        "expression": "A String", # Textual representation of an expression in Common Expression Language
+            # syntax.
+        "location": "A String", # Optional. String indicating the location of the expression for error
+            # reporting, e.g. a file name and a position in the file.
+        "title": "A String", # Optional. Title for the expression, i.e. a short string describing
+            # its purpose. This can be used e.g. in UIs which allow to enter the
+            # expression.
+      },
+      "members": [ # Specifies the principals requesting access for a Google Cloud resource.
+          # `members` can have the following values:
+          #
+          # * `allUsers`: A special identifier that represents anyone who is
+          #    on the internet; with or without a Google account.
+          #
+          # * `allAuthenticatedUsers`: A special identifier that represents anyone
+          #    who is authenticated with a Google account or a service account.
+          #    Does not include identities that come from external identity providers
+          #    (IdPs) through identity federation.
+          #
+          # * `user:{emailid}`: An email address that represents a specific Google
+          #    account. For example, `alice@example.com` .
+          #
+          #
+          # * `serviceAccount:{emailid}`: An email address that represents a Google
+          #    service account. For example,
+          #    `my-other-app@appspot.gserviceaccount.com`.
+          #
+          # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
+          #    identifier for a
+          #    [Kubernetes service
+          #    account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
+          #    For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
+          #
+          # * `group:{emailid}`: An email address that represents a Google group.
+          #    For example, `admins@example.com`.
+          #
+          #
+          # * `domain:{domain}`: The G Suite domain (primary) that represents all the
+          #    users of that domain. For example, `google.com` or `example.com`.
+          #
+          #
+          #
+          #
+          # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
+          #   A single identity in a workforce identity pool.
+          #
+          # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
+          #   All workforce identities in a group.
+          #
+          # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
+          #   All workforce identities with a specific attribute value.
+          #
+          # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
+          #   All identities in a workforce identity pool.
+          #
+          # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
+          #   A single identity in a workload identity pool.
+          #
+          # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
+          #   A workload identity pool group.
+          #
+          # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
+          #   All identities in a workload identity pool with a certain attribute.
+          #
+          # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
+          #   All identities in a workload identity pool.
+          #
+          # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
+          #    identifier) representing a user that has been recently deleted. For
+          #    example, `alice@example.com?uid=123456789012345678901`. If the user is
+          #    recovered, this value reverts to `user:{emailid}` and the recovered user
+          #    retains the role in the binding.
+          #
+          # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
+          #    unique identifier) representing a service account that has been recently
+          #    deleted. For example,
+          #    `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
+          #    If the service account is undeleted, this value reverts to
+          #    `serviceAccount:{emailid}` and the undeleted service account retains the
+          #    role in the binding.
+          #
+          # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
+          #    identifier) representing a Google group that has been recently
+          #    deleted. For example, `admins@example.com?uid=123456789012345678901`. If
+          #    the group is recovered, this value reverts to `group:{emailid}` and the
+          #    recovered group retains the role in the binding.
+          #
+          # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
+          #   Deleted single identity in a workforce identity pool. For example,
+          #   `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+        "A String",
+      ],
+      "role": "A String", # Role that is assigned to the list of `members`, or principals.
+          # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+          #
+          # For an overview of the IAM roles and permissions, see the
+          # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
+          # a list of the available pre-defined roles, see
+          # [here](https://cloud.google.com/iam/docs/understanding-roles).
+    },
+  ],
+  "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
+      # prevent simultaneous updates of a policy from overwriting each other.
+      # It is strongly suggested that systems make use of the `etag` in the
+      # read-modify-write cycle to perform policy updates in order to avoid race
+      # conditions: An `etag` is returned in the response to `getIamPolicy`, and
+      # systems are expected to put that etag in the request to `setIamPolicy` to
+      # ensure that their change will be applied to the same version of the policy.
+      #
+      # **Important:** If you use IAM Conditions, you must include the `etag` field
+      # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+      # you to overwrite a version `3` policy with a version `1` policy, and all of
+      # the conditions in the version `3` policy are lost.
+  "version": 42, # Specifies the format of the policy.
+      #
+      # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
+      # are rejected.
+      #
+      # Any operation that affects conditional role bindings must specify version
+      # `3`. This requirement applies to the following operations:
+      #
+      # * Getting a policy that includes a conditional role binding
+      # * Adding a conditional role binding to a policy
+      # * Changing a conditional role binding in a policy
+      # * Removing any role binding, with or without a condition, from a policy
+      #   that includes conditions
+      #
+      # **Important:** If you use IAM Conditions, you must include the `etag` field
+      # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+      # you to overwrite a version `3` policy with a version `1` policy, and all of
+      # the conditions in the version `3` policy are lost.
+      #
+      # If a policy does not include any conditions, operations on that policy may
+      # specify any valid version or leave the field unset.
+      #
+      # To learn which resources support conditions in their IAM policies, see the
+      # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+}
+
+ +
+ insert(project, region, body=None, requestId=None, sourceConsistencyGroup=None, x__xgafv=None) +
creates a Regional InstantSnapshotGroup resource
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, Name of the region for this request. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Represents an InstantSnapshotGroup resource.
+    # 
+    # An instant snapshot group is a set of instant snapshots that represents a
+    # point in time state of a consistency group.
+  "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339
+      # text format.
+  "description": "A String", # Optional. An optional description of this resource. Provide this property when you
+      # create the resource.
+  "id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is
+      # defined by the server.
+  "kind": "compute#instantSnapshotGroup", # Output only. [Output Only] Type of the resource. Alwayscompute#instantSnapshotGroup for InstantSnapshotGroup
+      # resources.
+  "name": "A String", # Identifier. Name of the resource; provided by the client when the resource is created.
+      # The name must be 1-63 characters long, and comply withRFC1035.
+      # Specifically, the name must be 1-63 characters long and match the regular
+      # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
+      # character must be a lowercase letter, and all following characters must be
+      # a dash, lowercase letter, or digit, except the last character, which cannot
+      # be a dash.
+  "region": "A String", # Output only. [Output Only] URL of the region where the instant snapshot group resides.
+      # You must specify this field as part of the HTTP request URL. It is
+      # not settable as a field in the request body.
+  "resourceStatus": {
+    "consistencyMembershipResolutionTime": "A String", # Output only. [Output Only]
+    "sourceInfo": { # Output only. [Output Only]
+      "consistencyGroup": "A String",
+      "consistencyGroupId": "A String",
+    },
+  },
+  "selfLink": "A String", # Output only. [Output Only] Server-defined URL for the resource.
+  "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource's resource id.
+  "sourceConsistencyGroup": "A String",
+  "status": "A String", # Output only. [Output Only]
+  "zone": "A String", # Output only. [Output Only] URL of the zone where the instant snapshot group resides.
+      # You must specify this field as part of the HTTP request URL. It is
+      # not settable as a field in the request body.
+}
+
+  requestId: string, An optional request ID to identify requests. Specify a unique request ID so
+that if you must retry your request, the server will know to ignore the
+request if it has already been completed.
+
+For example, consider a situation where you make an initial request and
+the request times out. If you make the request again with the same
+request ID, the server can check if original operation with the same
+request ID was received, and if so, will ignore the second request. This
+prevents clients from accidentally creating duplicate commitments.
+
+The request ID must be
+a valid UUID with the exception that zero UUID is not supported
+(00000000-0000-0000-0000-000000000000).
+  sourceConsistencyGroup: string, begin_interface: MixerMutationRequestBuilder
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an Operation resource.
+    #
+    # Google Compute Engine has three Operation resources:
+    #
+    # * [Global](/compute/docs/reference/rest/v1/globalOperations)
+    # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
+    # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
+    #
+    # You can use an operation resource to manage asynchronous API requests.
+    # For more information, readHandling
+    # API responses.
+    #
+    # Operations can be global, regional or zonal.
+    #
+    #    - For global operations, use the `globalOperations`
+    #    resource.
+    #    - For regional operations, use the
+    #    `regionOperations` resource.
+    #    - For zonal operations, use
+    #    the `zoneOperations` resource.
+    #
+    #
+    #
+    # For more information, read
+    # Global, Regional, and Zonal Resources.
+    #
+    # Note that completed Operation resources have a limited
+    # retention period.
+  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
+      # Not present otherwise.
+  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+  "description": "A String", # [Output Only] A textual description of the operation, which is
+      # set when the operation is created.
+  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
+      # text format.
+  "error": { # [Output Only] If errors are generated during processing of the operation,
+      # this field will be populated.
+    "errors": [ # [Output Only] The array of errors encountered while processing this
+        # operation.
+      {
+        "code": "A String", # [Output Only] The error type identifier for this error.
+        "errorDetails": [ # [Output Only] An optional list of messages that contain the error
+            # details. There is a set of defined message types to use for providing
+            # details.The syntax depends on the error code. For example,
+            # QuotaExceededInfo will have details when the error code is
+            # QUOTA_EXCEEDED.
+          {
+            "errorInfo": { # Describes the cause of the error with structured details.
+                #
+                # Example of an error when contacting the "pubsub.googleapis.com" API when it
+                # is not enabled:
+                #
+                #     { "reason": "API_DISABLED"
+                #       "domain": "googleapis.com"
+                #       "metadata": {
+                #         "resource": "projects/123",
+                #         "service": "pubsub.googleapis.com"
+                #       }
+                #     }
+                #
+                # This response indicates that the pubsub.googleapis.com API is not enabled.
+                #
+                # Example of an error that is returned when attempting to create a Spanner
+                # instance in a region that is out of stock:
+                #
+                #     { "reason": "STOCKOUT"
+                #       "domain": "spanner.googleapis.com",
+                #       "metadata": {
+                #         "availableRegions": "us-central1,us-east2"
+                #       }
+                #     }
+              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+                  # is typically the registered service name of the tool or product that
+                  # generates the error. Example: "pubsub.googleapis.com". If the error is
+                  # generated by some common infrastructure, the error domain must be a
+                  # globally unique value that identifies the infrastructure. For Google API
+                  # infrastructure, the error domain is "googleapis.com".
+              "metadatas": { # Additional structured details about this error.
+                  #
+                  # Keys must match a regular expression of `a-z+` but should
+                  # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+                  # length. When identifying the current value of an exceeded limit, the units
+                  # should be contained in the key, not the value.  For example, rather than
+                  # `{"instanceLimit": "100/request"}`, should be returned as,
+                  # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+                  # instances that can be created in a single (batch) request.
+                "a_key": "A String",
+              },
+              "reason": "A String", # The reason of the error. This is a constant value that identifies the
+                  # proximate cause of the error. Error reasons are unique within a particular
+                  # domain of errors. This should be at most 63 characters and match a
+                  # regular expression of `A-Z+[A-Z0-9]`, which represents
+                  # UPPER_SNAKE_CASE.
+            },
+            "help": { # Provides links to documentation or for performing an out of band action.
+                #
+                # For example, if a quota check failed with an error indicating the calling
+                # project hasn't enabled the accessed service, this can contain a URL pointing
+                # directly to the right place in the developer console to flip the bit.
+              "links": [ # URL(s) pointing to additional information on handling the current error.
+                { # Describes a URL link.
+                  "description": "A String", # Describes what the link offers.
+                  "url": "A String", # The URL of the link.
+                },
+              ],
+            },
+            "localizedMessage": { # Provides a localized error message that is safe to return to the user
+                # which can be attached to an RPC error.
+              "locale": "A String", # The locale used following the specification defined at
+                  # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+                  # Examples are: "en-US", "fr-CH", "es-MX"
+              "message": "A String", # The localized error message in the above locale.
+            },
+            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+              "dimensions": { # The map holding related quota dimensions.
+                "a_key": "A String",
+              },
+              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+                  #  type or metric.
+              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+                  # or metric.
+              "limitName": "A String", # The name of the quota limit.
+              "metricName": "A String", # The Compute Engine quota metric name.
+              "rolloutStatus": "A String", # Rollout status of the future quota limit.
+            },
+          },
+        ],
+        "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+            # This property is optional.
+        "message": "A String", # [Output Only] An optional, human-readable error message.
+      },
+    ],
+  },
+  "getVersionOperationMetadata": {
+    "inlineSbomInfo": {
+      "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+          # name and the value is the version.
+        "a_key": "A String",
+      },
+      "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+          # component name and the value is the version.
+        "a_key": "A String",
+      },
+    },
+  },
+  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
+      # message that was returned, such as `NOT FOUND`.
+  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
+      # status code that was returned. For example, a `404` means the
+      # resource was not found.
+  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
+      # defined by the server.
+  "insertTime": "A String", # [Output Only] The time that this operation was requested.
+      # This value is inRFC3339
+      # text format.
+  "instancesBulkInsertOperationMetadata": {
+    "perLocationStatus": { # Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
+            # error.
+        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
+            # if the flow is rolling forward or rolling back.
+        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+      },
+    },
+  },
+  "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
+      # Operation resources.
+  "name": "A String", # [Output Only] Name of the operation.
+  "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
+      # group of operations results from a `bulkInsert` API request.
+  "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
+      # `update`, or `delete`, and so on.
+  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
+      # There is no requirement that this be linear or support any granularity of
+      # operations. This should not be used to guess when the operation will be
+      # complete. This number should monotonically increase as the operation
+      # progresses.
+  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
+      # applicable when performing regional operations.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
+      # this field will contain information on all underlying zonal actions and
+      # their state.
+    "clientOperationId": "A String", # [Output Only] The client operation id.
+    "perLocationOperations": { # [Output Only] Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
+            # populated.
+            # different programming environments, including REST APIs and RPC APIs. It is
+            # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+            # three pieces of data: error code, error message, and error details.
+            #
+            # You can find out more about this error model and how to work with it in the
+            # [API Design Guide](https://cloud.google.com/apis/design/errors).
+          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+          "details": [ # A list of messages that carry the error details.  There is a common set of
+              # message types for APIs to use.
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+          "message": "A String", # A developer-facing error message, which should be in English. Any
+              # user-facing error message should be localized and sent in the
+              # google.rpc.Status.details field, or localized by the client.
+        },
+        "state": "A String", # [Output Only] Status of the action, which can be one of the following:
+            # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+      },
+    },
+  },
+  "startTime": "A String", # [Output Only] The time that this operation was started by the server.
+      # This value is inRFC3339
+      # text format.
+  "status": "A String", # [Output Only] The status of the operation, which can be one of the
+      # following:
+      # `PENDING`, `RUNNING`, or `DONE`.
+  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
+      # operation.
+  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
+      # of the target resource.
+  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
+      # operations related to creating a snapshot, this points to the disk
+      # that the snapshot was created from.
+  "user": "A String", # [Output Only] User who requested the operation, for example:
+      # `user@example.com` or
+      # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+  "warnings": [ # [Output Only] If warning messages are generated during processing of the
+      # operation, this field will be populated.
+    {
+      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+          # Engine returns NO_RESULTS_ON_PAGE if there
+          # are no results in the response.
+      "data": [ # [Output Only] Metadata about this warning in key:
+          # value format. For example:
+          #
+          # "data": [
+          #   {
+          #    "key": "scope",
+          #    "value": "zones/us-east1-d"
+          #   }
+        {
+          "key": "A String", # [Output Only] A key that provides more detail on the warning being
+              # returned. For example, for warnings where there are no results in a list
+              # request for a particular zone, this key might be scope and
+              # the key value might be the zone name. Other examples might be a key
+              # indicating a deprecated resource and a suggested replacement, or a
+              # warning about invalid network settings (for example, if an instance
+              # attempts to perform IP forwarding but is not enabled for IP forwarding).
+          "value": "A String", # [Output Only] A warning data value corresponding to the key.
+        },
+      ],
+      "message": "A String", # [Output Only] A human-readable description of the warning code.
+    },
+  ],
+  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
+      # applicable when performing per-zone operations.
+}
+
+ +
+ list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) +
retrieves the list of InstantSnapshotGroup resources contained within
+the specified region.
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, The name of the region for this request. (required)
+  filter: string, A filter expression that filters resources listed in the response. Most
+Compute resources support two types of filter expressions:
+expressions that support regular expressions and expressions that follow
+API improvement proposal AIP-160.
+These two types of filter expressions cannot be mixed in one request.
+
+If you want to use AIP-160, your expression must specify the field name, an
+operator, and the value that you want to use for filtering. The value
+must be a string, a number, or a boolean. The operator
+must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.
+
+For example, if you are filtering Compute Engine instances, you can
+exclude instances named `example-instance` by specifying
+`name != example-instance`.
+
+The `:*` comparison can be used to test whether a key has been defined.
+For example, to find all objects with `owner` label use:
+```
+labels.owner:*
+```
+
+You can also filter nested fields. For example, you could specify
+`scheduling.automaticRestart = false` to include instances only
+if they are not scheduled for automatic restarts. You can use filtering
+on nested fields to filter based onresource labels.
+
+To filter on multiple expressions, provide each separate expression within
+parentheses. For example:
+```
+(scheduling.automaticRestart = true)
+(cpuPlatform = "Intel Skylake")
+```
+By default, each expression is an `AND` expression. However, you
+can include `AND` and `OR` expressions explicitly.
+For example:
+```
+(cpuPlatform = "Intel Skylake") OR
+(cpuPlatform = "Intel Broadwell") AND
+(scheduling.automaticRestart = true)
+```
+
+If you want to use a regular expression, use the `eq` (equal) or `ne`
+(not equal) operator against a single un-parenthesized expression with or
+without quotes or against multiple parenthesized expressions. Examples:
+
+`fieldname eq unquoted literal`
+`fieldname eq 'single quoted literal'`
+`fieldname eq "double quoted literal"`
+`(fieldname1 eq literal) (fieldname2 ne "literal")`
+
+The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
+The literal value must match the entire field.
+
+For example, to filter for instances that do not end with name "instance",
+you would use `name ne .*instance`.
+
+You cannot combine constraints on multiple fields using regular
+expressions.
+  maxResults: integer, The maximum number of results per page that should be returned.
+If the number of available results is larger than `maxResults`,
+Compute Engine returns a `nextPageToken` that can be used to get
+the next page of results in subsequent list requests. Acceptable values are
+`0` to `500`, inclusive. (Default: `500`)
+  orderBy: string, Sorts list results by a certain order. By default, results
+are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation
+timestamp using `orderBy="creationTimestamp desc"`. This sorts
+results based on the `creationTimestamp` field in
+reverse chronological order (newest result first). Use this to sort
+resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by `name` or
+`creationTimestamp desc` is supported.
+  pageToken: string, Specifies a page token to use. Set `pageToken` to the
+`nextPageToken` returned by a previous list request to get
+the next page of results.
+  returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
+of failure. The default value is false.
+
+For example, when partial success behavior is enabled, aggregatedList for a
+single zone scope either returns all resources in the zone or no resources,
+with an error code.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Contains a list of InstantSnapshotGroup resources.
+  "etag": "A String",
+  "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+  "items": [ # A list of InstantSnapshotGroup resources.
+    { # Represents an InstantSnapshotGroup resource.
+        #
+        # An instant snapshot group is a set of instant snapshots that represents a
+        # point in time state of a consistency group.
+      "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339
+          # text format.
+      "description": "A String", # Optional. An optional description of this resource. Provide this property when you
+          # create the resource.
+      "id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is
+          # defined by the server.
+      "kind": "compute#instantSnapshotGroup", # Output only. [Output Only] Type of the resource. Alwayscompute#instantSnapshotGroup for InstantSnapshotGroup
+          # resources.
+      "name": "A String", # Identifier. Name of the resource; provided by the client when the resource is created.
+          # The name must be 1-63 characters long, and comply withRFC1035.
+          # Specifically, the name must be 1-63 characters long and match the regular
+          # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
+          # character must be a lowercase letter, and all following characters must be
+          # a dash, lowercase letter, or digit, except the last character, which cannot
+          # be a dash.
+      "region": "A String", # Output only. [Output Only] URL of the region where the instant snapshot group resides.
+          # You must specify this field as part of the HTTP request URL. It is
+          # not settable as a field in the request body.
+      "resourceStatus": {
+        "consistencyMembershipResolutionTime": "A String", # Output only. [Output Only]
+        "sourceInfo": { # Output only. [Output Only]
+          "consistencyGroup": "A String",
+          "consistencyGroupId": "A String",
+        },
+      },
+      "selfLink": "A String", # Output only. [Output Only] Server-defined URL for the resource.
+      "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource's resource id.
+      "sourceConsistencyGroup": "A String",
+      "status": "A String", # Output only. [Output Only]
+      "zone": "A String", # Output only. [Output Only] URL of the zone where the instant snapshot group resides.
+          # You must specify this field as part of the HTTP request URL. It is
+          # not settable as a field in the request body.
+    },
+  ],
+  "kind": "compute#instantSnapshotGroupsList", # Output only. Type of resource.
+  "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for
+      # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
+      # the query parameter pageToken in the next list request.
+      # Subsequent list requests will have their own nextPageToken to
+      # continue paging through the results.
+  "selfLink": "A String", # Output only. [Output Only] Server-defined URL for this resource.
+  "unreachables": [ # Output only. [Output Only] Unreachable resources.
+      # end_interface: MixerListResponseWithEtagBuilder
+    "A String",
+  ],
+  "warning": { # [Output Only] Informational warning message.
+    "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+        # Engine returns NO_RESULTS_ON_PAGE if there
+        # are no results in the response.
+    "data": [ # [Output Only] Metadata about this warning in key:
+        # value format. For example:
+        #
+        # "data": [
+        #   {
+        #    "key": "scope",
+        #    "value": "zones/us-east1-d"
+        #   }
+      {
+        "key": "A String", # [Output Only] A key that provides more detail on the warning being
+            # returned. For example, for warnings where there are no results in a list
+            # request for a particular zone, this key might be scope and
+            # the key value might be the zone name. Other examples might be a key
+            # indicating a deprecated resource and a suggested replacement, or a
+            # warning about invalid network settings (for example, if an instance
+            # attempts to perform IP forwarding but is not enabled for IP forwarding).
+        "value": "A String", # [Output Only] A warning data value corresponding to the key.
+      },
+    ],
+    "message": "A String", # [Output Only] A human-readable description of the warning code.
+  },
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ setIamPolicy(project, region, resource, body=None, x__xgafv=None) +
Sets the access control policy on the specified resource.
+Replaces any existing policy.
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, The name of the region for this request. (required)
+  resource: string, Name or id of the resource for this request. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{
+  "bindings": [ # Flatten Policy to create a backwacd compatible wire-format.
+      # Deprecated. Use 'policy' to specify bindings.
+    { # Associates `members`, or principals, with a `role`.
+      "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
+          #
+          # If the condition evaluates to `true`, then this binding applies to the
+          # current request.
+          #
+          # If the condition evaluates to `false`, then this binding does not apply to
+          # the current request. However, a different role binding might grant the same
+          # role to one or more of the principals in this binding.
+          #
+          # To learn which resources support conditions in their IAM policies, see the
+          # [IAM
+          # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+          # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
+          # are documented at https://github.com/google/cel-spec.
+          #
+          # Example (Comparison):
+          #
+          #     title: "Summary size limit"
+          #     description: "Determines if a summary is less than 100 chars"
+          #     expression: "document.summary.size() < 100"
+          #
+          # Example (Equality):
+          #
+          #     title: "Requestor is owner"
+          #     description: "Determines if requestor is the document owner"
+          #     expression: "document.owner == request.auth.claims.email"
+          #
+          # Example (Logic):
+          #
+          #     title: "Public documents"
+          #     description: "Determine whether the document should be publicly visible"
+          #     expression: "document.type != 'private' && document.type != 'internal'"
+          #
+          # Example (Data Manipulation):
+          #
+          #     title: "Notification string"
+          #     description: "Create a notification string with a timestamp."
+          #     expression: "'New message received at ' + string(document.create_time)"
+          #
+          # The exact variables and functions that may be referenced within an expression
+          # are determined by the service that evaluates it. See the service
+          # documentation for additional information.
+        "description": "A String", # Optional. Description of the expression. This is a longer text which
+            # describes the expression, e.g. when hovered over it in a UI.
+        "expression": "A String", # Textual representation of an expression in Common Expression Language
+            # syntax.
+        "location": "A String", # Optional. String indicating the location of the expression for error
+            # reporting, e.g. a file name and a position in the file.
+        "title": "A String", # Optional. Title for the expression, i.e. a short string describing
+            # its purpose. This can be used e.g. in UIs which allow to enter the
+            # expression.
+      },
+      "members": [ # Specifies the principals requesting access for a Google Cloud resource.
+          # `members` can have the following values:
+          #
+          # * `allUsers`: A special identifier that represents anyone who is
+          #    on the internet; with or without a Google account.
+          #
+          # * `allAuthenticatedUsers`: A special identifier that represents anyone
+          #    who is authenticated with a Google account or a service account.
+          #    Does not include identities that come from external identity providers
+          #    (IdPs) through identity federation.
+          #
+          # * `user:{emailid}`: An email address that represents a specific Google
+          #    account. For example, `alice@example.com` .
+          #
+          #
+          # * `serviceAccount:{emailid}`: An email address that represents a Google
+          #    service account. For example,
+          #    `my-other-app@appspot.gserviceaccount.com`.
+          #
+          # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
+          #    identifier for a
+          #    [Kubernetes service
+          #    account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
+          #    For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
+          #
+          # * `group:{emailid}`: An email address that represents a Google group.
+          #    For example, `admins@example.com`.
+          #
+          #
+          # * `domain:{domain}`: The G Suite domain (primary) that represents all the
+          #    users of that domain. For example, `google.com` or `example.com`.
+          #
+          #
+          #
+          #
+          # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
+          #   A single identity in a workforce identity pool.
+          #
+          # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
+          #   All workforce identities in a group.
+          #
+          # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
+          #   All workforce identities with a specific attribute value.
+          #
+          # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
+          #   All identities in a workforce identity pool.
+          #
+          # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
+          #   A single identity in a workload identity pool.
+          #
+          # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
+          #   A workload identity pool group.
+          #
+          # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
+          #   All identities in a workload identity pool with a certain attribute.
+          #
+          # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
+          #   All identities in a workload identity pool.
+          #
+          # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
+          #    identifier) representing a user that has been recently deleted. For
+          #    example, `alice@example.com?uid=123456789012345678901`. If the user is
+          #    recovered, this value reverts to `user:{emailid}` and the recovered user
+          #    retains the role in the binding.
+          #
+          # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
+          #    unique identifier) representing a service account that has been recently
+          #    deleted. For example,
+          #    `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
+          #    If the service account is undeleted, this value reverts to
+          #    `serviceAccount:{emailid}` and the undeleted service account retains the
+          #    role in the binding.
+          #
+          # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
+          #    identifier) representing a Google group that has been recently
+          #    deleted. For example, `admins@example.com?uid=123456789012345678901`. If
+          #    the group is recovered, this value reverts to `group:{emailid}` and the
+          #    recovered group retains the role in the binding.
+          #
+          # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
+          #   Deleted single identity in a workforce identity pool. For example,
+          #   `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+        "A String",
+      ],
+      "role": "A String", # Role that is assigned to the list of `members`, or principals.
+          # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+          #
+          # For an overview of the IAM roles and permissions, see the
+          # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
+          # a list of the available pre-defined roles, see
+          # [here](https://cloud.google.com/iam/docs/understanding-roles).
+    },
+  ],
+  "etag": "A String", # Flatten Policy to create a backward compatible wire-format.
+      # Deprecated. Use 'policy' to specify the etag.
+  "policy": { # An Identity and Access Management (IAM) policy, which specifies access # REQUIRED: The complete policy to be applied to the 'resource'. The size of
+      # the policy is limited to a few 10s of KB. An empty policy is in general a
+      # valid policy but certain services (like Projects) might reject them.
+      # controls for Google Cloud resources.
+      #
+      #
+      # A `Policy` is a collection of `bindings`. A `binding` binds one or more
+      # `members`, or principals, to a single `role`. Principals can be user
+      # accounts, service accounts, Google groups, and domains (such as G Suite). A
+      # `role` is a named list of permissions; each `role` can be an IAM predefined
+      # role or a user-created custom role.
+      #
+      # For some types of Google Cloud resources, a `binding` can also specify a
+      # `condition`, which is a logical expression that allows access to a resource
+      # only if the expression evaluates to `true`. A condition can add constraints
+      # based on attributes of the request, the resource, or both. To learn which
+      # resources support conditions in their IAM policies, see the
+      # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+      #
+      # **JSON example:**
+      #
+      # ```
+      #     {
+      #       "bindings": [
+      #         {
+      #           "role": "roles/resourcemanager.organizationAdmin",
+      #           "members": [
+      #             "user:mike@example.com",
+      #             "group:admins@example.com",
+      #             "domain:google.com",
+      #             "serviceAccount:my-project-id@appspot.gserviceaccount.com"
+      #           ]
+      #         },
+      #         {
+      #           "role": "roles/resourcemanager.organizationViewer",
+      #           "members": [
+      #             "user:eve@example.com"
+      #           ],
+      #           "condition": {
+      #             "title": "expirable access",
+      #             "description": "Does not grant access after Sep 2020",
+      #             "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
+      #           }
+      #         }
+      #       ],
+      #       "etag": "BwWWja0YfJA=",
+      #       "version": 3
+      #     }
+      # ```
+      #
+      # **YAML example:**
+      #
+      # ```
+      #     bindings:
+      #     - members:
+      #       - user:mike@example.com
+      #       - group:admins@example.com
+      #       - domain:google.com
+      #       - serviceAccount:my-project-id@appspot.gserviceaccount.com
+      #       role: roles/resourcemanager.organizationAdmin
+      #     - members:
+      #       - user:eve@example.com
+      #       role: roles/resourcemanager.organizationViewer
+      #       condition:
+      #         title: expirable access
+      #         description: Does not grant access after Sep 2020
+      #         expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
+      #     etag: BwWWja0YfJA=
+      #     version: 3
+      # ```
+      #
+      # For a description of IAM and its features, see the
+      # [IAM documentation](https://cloud.google.com/iam/docs/).
+    "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+      { # Specifies the audit configuration for a service.
+          # The configuration determines which permission types are logged, and what
+          # identities, if any, are exempted from logging.
+          # An AuditConfig must have one or more AuditLogConfigs.
+          #
+          # If there are AuditConfigs for both `allServices` and a specific service,
+          # the union of the two AuditConfigs is used for that service: the log_types
+          # specified in each AuditConfig are enabled, and the exempted_members in each
+          # AuditLogConfig are exempted.
+          #
+          # Example Policy with multiple AuditConfigs:
+          #
+          #     {
+          #       "audit_configs": [
+          #         {
+          #           "service": "allServices",
+          #           "audit_log_configs": [
+          #             {
+          #               "log_type": "DATA_READ",
+          #               "exempted_members": [
+          #                 "user:jose@example.com"
+          #               ]
+          #             },
+          #             {
+          #               "log_type": "DATA_WRITE"
+          #             },
+          #             {
+          #               "log_type": "ADMIN_READ"
+          #             }
+          #           ]
+          #         },
+          #         {
+          #           "service": "sampleservice.googleapis.com",
+          #           "audit_log_configs": [
+          #             {
+          #               "log_type": "DATA_READ"
+          #             },
+          #             {
+          #               "log_type": "DATA_WRITE",
+          #               "exempted_members": [
+          #                 "user:aliya@example.com"
+          #               ]
+          #             }
+          #           ]
+          #         }
+          #       ]
+          #     }
+          #
+          # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
+          # logging. It also exempts `jose@example.com` from DATA_READ logging, and
+          # `aliya@example.com` from DATA_WRITE logging.
+        "auditLogConfigs": [ # The configuration for logging of each type of permission.
+          { # Provides the configuration for logging a type of permissions.
+              # Example:
+              #
+              #     {
+              #       "audit_log_configs": [
+              #         {
+              #           "log_type": "DATA_READ",
+              #           "exempted_members": [
+              #             "user:jose@example.com"
+              #           ]
+              #         },
+              #         {
+              #           "log_type": "DATA_WRITE"
+              #         }
+              #       ]
+              #     }
+              #
+              # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
+              # jose@example.com from DATA_READ logging.
+            "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
+                # permission.
+                # Follows the same format of Binding.members.
+              "A String",
+            ],
+            "logType": "A String", # The log type that this config enables.
+          },
+        ],
+        "service": "A String", # Specifies a service that will be enabled for audit logging.
+            # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
+            # `allServices` is a special value that covers all services.
+      },
+    ],
+    "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally,
+        # may specify a `condition` that determines how and when the `bindings` are
+        # applied. Each of the `bindings` must contain at least one principal.
+        #
+        # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
+        # of these principals can be Google groups. Each occurrence of a principal
+        # counts towards these limits. For example, if the `bindings` grant 50
+        # different roles to `user:alice@example.com`, and not to any other
+        # principal, then you can add another 1,450 principals to the `bindings` in
+        # the `Policy`.
+      { # Associates `members`, or principals, with a `role`.
+        "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
+            #
+            # If the condition evaluates to `true`, then this binding applies to the
+            # current request.
+            #
+            # If the condition evaluates to `false`, then this binding does not apply to
+            # the current request. However, a different role binding might grant the same
+            # role to one or more of the principals in this binding.
+            #
+            # To learn which resources support conditions in their IAM policies, see the
+            # [IAM
+            # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+            # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
+            # are documented at https://github.com/google/cel-spec.
+            #
+            # Example (Comparison):
+            #
+            #     title: "Summary size limit"
+            #     description: "Determines if a summary is less than 100 chars"
+            #     expression: "document.summary.size() < 100"
+            #
+            # Example (Equality):
+            #
+            #     title: "Requestor is owner"
+            #     description: "Determines if requestor is the document owner"
+            #     expression: "document.owner == request.auth.claims.email"
+            #
+            # Example (Logic):
+            #
+            #     title: "Public documents"
+            #     description: "Determine whether the document should be publicly visible"
+            #     expression: "document.type != 'private' && document.type != 'internal'"
+            #
+            # Example (Data Manipulation):
+            #
+            #     title: "Notification string"
+            #     description: "Create a notification string with a timestamp."
+            #     expression: "'New message received at ' + string(document.create_time)"
+            #
+            # The exact variables and functions that may be referenced within an expression
+            # are determined by the service that evaluates it. See the service
+            # documentation for additional information.
+          "description": "A String", # Optional. Description of the expression. This is a longer text which
+              # describes the expression, e.g. when hovered over it in a UI.
+          "expression": "A String", # Textual representation of an expression in Common Expression Language
+              # syntax.
+          "location": "A String", # Optional. String indicating the location of the expression for error
+              # reporting, e.g. a file name and a position in the file.
+          "title": "A String", # Optional. Title for the expression, i.e. a short string describing
+              # its purpose. This can be used e.g. in UIs which allow to enter the
+              # expression.
+        },
+        "members": [ # Specifies the principals requesting access for a Google Cloud resource.
+            # `members` can have the following values:
+            #
+            # * `allUsers`: A special identifier that represents anyone who is
+            #    on the internet; with or without a Google account.
+            #
+            # * `allAuthenticatedUsers`: A special identifier that represents anyone
+            #    who is authenticated with a Google account or a service account.
+            #    Does not include identities that come from external identity providers
+            #    (IdPs) through identity federation.
+            #
+            # * `user:{emailid}`: An email address that represents a specific Google
+            #    account. For example, `alice@example.com` .
+            #
+            #
+            # * `serviceAccount:{emailid}`: An email address that represents a Google
+            #    service account. For example,
+            #    `my-other-app@appspot.gserviceaccount.com`.
+            #
+            # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
+            #    identifier for a
+            #    [Kubernetes service
+            #    account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
+            #    For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
+            #
+            # * `group:{emailid}`: An email address that represents a Google group.
+            #    For example, `admins@example.com`.
+            #
+            #
+            # * `domain:{domain}`: The G Suite domain (primary) that represents all the
+            #    users of that domain. For example, `google.com` or `example.com`.
+            #
+            #
+            #
+            #
+            # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
+            #   A single identity in a workforce identity pool.
+            #
+            # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
+            #   All workforce identities in a group.
+            #
+            # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
+            #   All workforce identities with a specific attribute value.
+            #
+            # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
+            #   All identities in a workforce identity pool.
+            #
+            # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
+            #   A single identity in a workload identity pool.
+            #
+            # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
+            #   A workload identity pool group.
+            #
+            # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
+            #   All identities in a workload identity pool with a certain attribute.
+            #
+            # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
+            #   All identities in a workload identity pool.
+            #
+            # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
+            #    identifier) representing a user that has been recently deleted. For
+            #    example, `alice@example.com?uid=123456789012345678901`. If the user is
+            #    recovered, this value reverts to `user:{emailid}` and the recovered user
+            #    retains the role in the binding.
+            #
+            # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
+            #    unique identifier) representing a service account that has been recently
+            #    deleted. For example,
+            #    `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
+            #    If the service account is undeleted, this value reverts to
+            #    `serviceAccount:{emailid}` and the undeleted service account retains the
+            #    role in the binding.
+            #
+            # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
+            #    identifier) representing a Google group that has been recently
+            #    deleted. For example, `admins@example.com?uid=123456789012345678901`. If
+            #    the group is recovered, this value reverts to `group:{emailid}` and the
+            #    recovered group retains the role in the binding.
+            #
+            # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
+            #   Deleted single identity in a workforce identity pool. For example,
+            #   `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+          "A String",
+        ],
+        "role": "A String", # Role that is assigned to the list of `members`, or principals.
+            # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+            #
+            # For an overview of the IAM roles and permissions, see the
+            # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
+            # a list of the available pre-defined roles, see
+            # [here](https://cloud.google.com/iam/docs/understanding-roles).
+      },
+    ],
+    "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
+        # prevent simultaneous updates of a policy from overwriting each other.
+        # It is strongly suggested that systems make use of the `etag` in the
+        # read-modify-write cycle to perform policy updates in order to avoid race
+        # conditions: An `etag` is returned in the response to `getIamPolicy`, and
+        # systems are expected to put that etag in the request to `setIamPolicy` to
+        # ensure that their change will be applied to the same version of the policy.
+        #
+        # **Important:** If you use IAM Conditions, you must include the `etag` field
+        # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+        # you to overwrite a version `3` policy with a version `1` policy, and all of
+        # the conditions in the version `3` policy are lost.
+    "version": 42, # Specifies the format of the policy.
+        #
+        # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
+        # are rejected.
+        #
+        # Any operation that affects conditional role bindings must specify version
+        # `3`. This requirement applies to the following operations:
+        #
+        # * Getting a policy that includes a conditional role binding
+        # * Adding a conditional role binding to a policy
+        # * Changing a conditional role binding in a policy
+        # * Removing any role binding, with or without a condition, from a policy
+        #   that includes conditions
+        #
+        # **Important:** If you use IAM Conditions, you must include the `etag` field
+        # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+        # you to overwrite a version `3` policy with a version `1` policy, and all of
+        # the conditions in the version `3` policy are lost.
+        #
+        # If a policy does not include any conditions, operations on that policy may
+        # specify any valid version or leave the field unset.
+        #
+        # To learn which resources support conditions in their IAM policies, see the
+        # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An Identity and Access Management (IAM) policy, which specifies access
+    # controls for Google Cloud resources.
+    #
+    #
+    # A `Policy` is a collection of `bindings`. A `binding` binds one or more
+    # `members`, or principals, to a single `role`. Principals can be user
+    # accounts, service accounts, Google groups, and domains (such as G Suite). A
+    # `role` is a named list of permissions; each `role` can be an IAM predefined
+    # role or a user-created custom role.
+    #
+    # For some types of Google Cloud resources, a `binding` can also specify a
+    # `condition`, which is a logical expression that allows access to a resource
+    # only if the expression evaluates to `true`. A condition can add constraints
+    # based on attributes of the request, the resource, or both. To learn which
+    # resources support conditions in their IAM policies, see the
+    # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+    #
+    # **JSON example:**
+    #
+    # ```
+    #     {
+    #       "bindings": [
+    #         {
+    #           "role": "roles/resourcemanager.organizationAdmin",
+    #           "members": [
+    #             "user:mike@example.com",
+    #             "group:admins@example.com",
+    #             "domain:google.com",
+    #             "serviceAccount:my-project-id@appspot.gserviceaccount.com"
+    #           ]
+    #         },
+    #         {
+    #           "role": "roles/resourcemanager.organizationViewer",
+    #           "members": [
+    #             "user:eve@example.com"
+    #           ],
+    #           "condition": {
+    #             "title": "expirable access",
+    #             "description": "Does not grant access after Sep 2020",
+    #             "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
+    #           }
+    #         }
+    #       ],
+    #       "etag": "BwWWja0YfJA=",
+    #       "version": 3
+    #     }
+    # ```
+    #
+    # **YAML example:**
+    #
+    # ```
+    #     bindings:
+    #     - members:
+    #       - user:mike@example.com
+    #       - group:admins@example.com
+    #       - domain:google.com
+    #       - serviceAccount:my-project-id@appspot.gserviceaccount.com
+    #       role: roles/resourcemanager.organizationAdmin
+    #     - members:
+    #       - user:eve@example.com
+    #       role: roles/resourcemanager.organizationViewer
+    #       condition:
+    #         title: expirable access
+    #         description: Does not grant access after Sep 2020
+    #         expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
+    #     etag: BwWWja0YfJA=
+    #     version: 3
+    # ```
+    #
+    # For a description of IAM and its features, see the
+    # [IAM documentation](https://cloud.google.com/iam/docs/).
+  "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+    { # Specifies the audit configuration for a service.
+        # The configuration determines which permission types are logged, and what
+        # identities, if any, are exempted from logging.
+        # An AuditConfig must have one or more AuditLogConfigs.
+        #
+        # If there are AuditConfigs for both `allServices` and a specific service,
+        # the union of the two AuditConfigs is used for that service: the log_types
+        # specified in each AuditConfig are enabled, and the exempted_members in each
+        # AuditLogConfig are exempted.
+        #
+        # Example Policy with multiple AuditConfigs:
+        #
+        #     {
+        #       "audit_configs": [
+        #         {
+        #           "service": "allServices",
+        #           "audit_log_configs": [
+        #             {
+        #               "log_type": "DATA_READ",
+        #               "exempted_members": [
+        #                 "user:jose@example.com"
+        #               ]
+        #             },
+        #             {
+        #               "log_type": "DATA_WRITE"
+        #             },
+        #             {
+        #               "log_type": "ADMIN_READ"
+        #             }
+        #           ]
+        #         },
+        #         {
+        #           "service": "sampleservice.googleapis.com",
+        #           "audit_log_configs": [
+        #             {
+        #               "log_type": "DATA_READ"
+        #             },
+        #             {
+        #               "log_type": "DATA_WRITE",
+        #               "exempted_members": [
+        #                 "user:aliya@example.com"
+        #               ]
+        #             }
+        #           ]
+        #         }
+        #       ]
+        #     }
+        #
+        # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
+        # logging. It also exempts `jose@example.com` from DATA_READ logging, and
+        # `aliya@example.com` from DATA_WRITE logging.
+      "auditLogConfigs": [ # The configuration for logging of each type of permission.
+        { # Provides the configuration for logging a type of permissions.
+            # Example:
+            #
+            #     {
+            #       "audit_log_configs": [
+            #         {
+            #           "log_type": "DATA_READ",
+            #           "exempted_members": [
+            #             "user:jose@example.com"
+            #           ]
+            #         },
+            #         {
+            #           "log_type": "DATA_WRITE"
+            #         }
+            #       ]
+            #     }
+            #
+            # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
+            # jose@example.com from DATA_READ logging.
+          "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
+              # permission.
+              # Follows the same format of Binding.members.
+            "A String",
+          ],
+          "logType": "A String", # The log type that this config enables.
+        },
+      ],
+      "service": "A String", # Specifies a service that will be enabled for audit logging.
+          # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
+          # `allServices` is a special value that covers all services.
+    },
+  ],
+  "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally,
+      # may specify a `condition` that determines how and when the `bindings` are
+      # applied. Each of the `bindings` must contain at least one principal.
+      #
+      # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
+      # of these principals can be Google groups. Each occurrence of a principal
+      # counts towards these limits. For example, if the `bindings` grant 50
+      # different roles to `user:alice@example.com`, and not to any other
+      # principal, then you can add another 1,450 principals to the `bindings` in
+      # the `Policy`.
+    { # Associates `members`, or principals, with a `role`.
+      "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
+          #
+          # If the condition evaluates to `true`, then this binding applies to the
+          # current request.
+          #
+          # If the condition evaluates to `false`, then this binding does not apply to
+          # the current request. However, a different role binding might grant the same
+          # role to one or more of the principals in this binding.
+          #
+          # To learn which resources support conditions in their IAM policies, see the
+          # [IAM
+          # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+          # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
+          # are documented at https://github.com/google/cel-spec.
+          #
+          # Example (Comparison):
+          #
+          #     title: "Summary size limit"
+          #     description: "Determines if a summary is less than 100 chars"
+          #     expression: "document.summary.size() < 100"
+          #
+          # Example (Equality):
+          #
+          #     title: "Requestor is owner"
+          #     description: "Determines if requestor is the document owner"
+          #     expression: "document.owner == request.auth.claims.email"
+          #
+          # Example (Logic):
+          #
+          #     title: "Public documents"
+          #     description: "Determine whether the document should be publicly visible"
+          #     expression: "document.type != 'private' && document.type != 'internal'"
+          #
+          # Example (Data Manipulation):
+          #
+          #     title: "Notification string"
+          #     description: "Create a notification string with a timestamp."
+          #     expression: "'New message received at ' + string(document.create_time)"
+          #
+          # The exact variables and functions that may be referenced within an expression
+          # are determined by the service that evaluates it. See the service
+          # documentation for additional information.
+        "description": "A String", # Optional. Description of the expression. This is a longer text which
+            # describes the expression, e.g. when hovered over it in a UI.
+        "expression": "A String", # Textual representation of an expression in Common Expression Language
+            # syntax.
+        "location": "A String", # Optional. String indicating the location of the expression for error
+            # reporting, e.g. a file name and a position in the file.
+        "title": "A String", # Optional. Title for the expression, i.e. a short string describing
+            # its purpose. This can be used e.g. in UIs which allow to enter the
+            # expression.
+      },
+      "members": [ # Specifies the principals requesting access for a Google Cloud resource.
+          # `members` can have the following values:
+          #
+          # * `allUsers`: A special identifier that represents anyone who is
+          #    on the internet; with or without a Google account.
+          #
+          # * `allAuthenticatedUsers`: A special identifier that represents anyone
+          #    who is authenticated with a Google account or a service account.
+          #    Does not include identities that come from external identity providers
+          #    (IdPs) through identity federation.
+          #
+          # * `user:{emailid}`: An email address that represents a specific Google
+          #    account. For example, `alice@example.com` .
+          #
+          #
+          # * `serviceAccount:{emailid}`: An email address that represents a Google
+          #    service account. For example,
+          #    `my-other-app@appspot.gserviceaccount.com`.
+          #
+          # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
+          #    identifier for a
+          #    [Kubernetes service
+          #    account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
+          #    For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
+          #
+          # * `group:{emailid}`: An email address that represents a Google group.
+          #    For example, `admins@example.com`.
+          #
+          #
+          # * `domain:{domain}`: The G Suite domain (primary) that represents all the
+          #    users of that domain. For example, `google.com` or `example.com`.
+          #
+          #
+          #
+          #
+          # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
+          #   A single identity in a workforce identity pool.
+          #
+          # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
+          #   All workforce identities in a group.
+          #
+          # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
+          #   All workforce identities with a specific attribute value.
+          #
+          # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
+          #   All identities in a workforce identity pool.
+          #
+          # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
+          #   A single identity in a workload identity pool.
+          #
+          # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
+          #   A workload identity pool group.
+          #
+          # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
+          #   All identities in a workload identity pool with a certain attribute.
+          #
+          # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
+          #   All identities in a workload identity pool.
+          #
+          # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
+          #    identifier) representing a user that has been recently deleted. For
+          #    example, `alice@example.com?uid=123456789012345678901`. If the user is
+          #    recovered, this value reverts to `user:{emailid}` and the recovered user
+          #    retains the role in the binding.
+          #
+          # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
+          #    unique identifier) representing a service account that has been recently
+          #    deleted. For example,
+          #    `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
+          #    If the service account is undeleted, this value reverts to
+          #    `serviceAccount:{emailid}` and the undeleted service account retains the
+          #    role in the binding.
+          #
+          # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
+          #    identifier) representing a Google group that has been recently
+          #    deleted. For example, `admins@example.com?uid=123456789012345678901`. If
+          #    the group is recovered, this value reverts to `group:{emailid}` and the
+          #    recovered group retains the role in the binding.
+          #
+          # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
+          #   Deleted single identity in a workforce identity pool. For example,
+          #   `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+        "A String",
+      ],
+      "role": "A String", # Role that is assigned to the list of `members`, or principals.
+          # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+          #
+          # For an overview of the IAM roles and permissions, see the
+          # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
+          # a list of the available pre-defined roles, see
+          # [here](https://cloud.google.com/iam/docs/understanding-roles).
+    },
+  ],
+  "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
+      # prevent simultaneous updates of a policy from overwriting each other.
+      # It is strongly suggested that systems make use of the `etag` in the
+      # read-modify-write cycle to perform policy updates in order to avoid race
+      # conditions: An `etag` is returned in the response to `getIamPolicy`, and
+      # systems are expected to put that etag in the request to `setIamPolicy` to
+      # ensure that their change will be applied to the same version of the policy.
+      #
+      # **Important:** If you use IAM Conditions, you must include the `etag` field
+      # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+      # you to overwrite a version `3` policy with a version `1` policy, and all of
+      # the conditions in the version `3` policy are lost.
+  "version": 42, # Specifies the format of the policy.
+      #
+      # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
+      # are rejected.
+      #
+      # Any operation that affects conditional role bindings must specify version
+      # `3`. This requirement applies to the following operations:
+      #
+      # * Getting a policy that includes a conditional role binding
+      # * Adding a conditional role binding to a policy
+      # * Changing a conditional role binding in a policy
+      # * Removing any role binding, with or without a condition, from a policy
+      #   that includes conditions
+      #
+      # **Important:** If you use IAM Conditions, you must include the `etag` field
+      # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+      # you to overwrite a version `3` policy with a version `1` policy, and all of
+      # the conditions in the version `3` policy are lost.
+      #
+      # If a policy does not include any conditions, operations on that policy may
+      # specify any valid version or leave the field unset.
+      #
+      # To learn which resources support conditions in their IAM policies, see the
+      # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+}
+
+ +
+ testIamPermissions(project, region, resource, body=None, x__xgafv=None) +
Returns permissions that a caller has on the specified resource.
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, The name of the region for this request. (required)
+  resource: string, Name or id of the resource for this request. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{
+  "permissions": [ # The set of permissions to check for the 'resource'. Permissions with
+      # wildcards (such as '*' or 'storage.*') are not allowed.
+    "A String",
+  ],
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is
+      # allowed.
+    "A String",
+  ],
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/compute_v1.regionInstantSnapshots.html b/docs/dyn/compute_v1.regionInstantSnapshots.html index 40f3feacb1..5daca22c1a 100644 --- a/docs/dyn/compute_v1.regionInstantSnapshots.html +++ b/docs/dyn/compute_v1.regionInstantSnapshots.html @@ -508,6 +508,13 @@

Method Details

"sourceDiskId": "A String", # Output only. [Output Only] The ID value of the disk used to create this InstantSnapshot. # This value may be used to determine whether the InstantSnapshot # was taken from the current or a previous instance of a given disk name. + "sourceInstantSnapshotGroup": "A String", # Output only. [Output Only] URL of the source instant snapshot this instant snapshot is + # part of. Note that the source instant snapshot group must be in the same + # zone/region as the instant snapshot to be created. This can be a full or + # valid partial URL. + "sourceInstantSnapshotGroupId": "A String", # Output only. [Output Only] The ID value of the source instant snapshot group this + # InstantSnapshot is part of. This value may be used to determine whether the + # InstantSnapshot was created as part of an InstantSnapshotGroup creation. "status": "A String", # Output only. [Output Only] The status of the instantSnapshot. This can beCREATING, DELETING, FAILED, orREADY. "zone": "A String", # Output only. [Output Only] URL of the zone where the instant snapshot resides. # You must specify this field as part of the HTTP request URL. It is @@ -976,6 +983,13 @@

Method Details

"sourceDiskId": "A String", # Output only. [Output Only] The ID value of the disk used to create this InstantSnapshot. # This value may be used to determine whether the InstantSnapshot # was taken from the current or a previous instance of a given disk name. + "sourceInstantSnapshotGroup": "A String", # Output only. [Output Only] URL of the source instant snapshot this instant snapshot is + # part of. Note that the source instant snapshot group must be in the same + # zone/region as the instant snapshot to be created. This can be a full or + # valid partial URL. + "sourceInstantSnapshotGroupId": "A String", # Output only. [Output Only] The ID value of the source instant snapshot group this + # InstantSnapshot is part of. This value may be used to determine whether the + # InstantSnapshot was created as part of an InstantSnapshotGroup creation. "status": "A String", # Output only. [Output Only] The status of the instantSnapshot. This can beCREATING, DELETING, FAILED, orREADY. "zone": "A String", # Output only. [Output Only] URL of the zone where the instant snapshot resides. # You must specify this field as part of the HTTP request URL. It is @@ -1451,6 +1465,13 @@

Method Details

"sourceDiskId": "A String", # Output only. [Output Only] The ID value of the disk used to create this InstantSnapshot. # This value may be used to determine whether the InstantSnapshot # was taken from the current or a previous instance of a given disk name. + "sourceInstantSnapshotGroup": "A String", # Output only. [Output Only] URL of the source instant snapshot this instant snapshot is + # part of. Note that the source instant snapshot group must be in the same + # zone/region as the instant snapshot to be created. This can be a full or + # valid partial URL. + "sourceInstantSnapshotGroupId": "A String", # Output only. [Output Only] The ID value of the source instant snapshot group this + # InstantSnapshot is part of. This value may be used to determine whether the + # InstantSnapshot was created as part of an InstantSnapshotGroup creation. "status": "A String", # Output only. [Output Only] The status of the instantSnapshot. This can beCREATING, DELETING, FAILED, orREADY. "zone": "A String", # Output only. [Output Only] URL of the zone where the instant snapshot resides. # You must specify this field as part of the HTTP request URL. It is diff --git a/docs/dyn/compute_v1.regionSnapshotSettings.html b/docs/dyn/compute_v1.regionSnapshotSettings.html new file mode 100644 index 0000000000..eb93c86b64 --- /dev/null +++ b/docs/dyn/compute_v1.regionSnapshotSettings.html @@ -0,0 +1,454 @@ + + + +

Compute Engine API . regionSnapshotSettings

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(project, region, x__xgafv=None)

+

Get region snapshot settings.

+

+ patch(project, region, body=None, requestId=None, updateMask=None, x__xgafv=None)

+

Patch region snapshot settings.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(project, region, x__xgafv=None) +
Get region snapshot settings.
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, Name of the region for this request. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "accessLocation": { # (Regional snapshots use only)Policy of which location is allowed to access
+      # snapshot.
+    "locations": { # List of regions that can restore a regional
+        #  snapshot from the current region
+      "a_key": { # A structure for specifying an allowed target region.
+        "region": "A String", # Accessible region name
+      },
+    },
+    "policy": "A String", # Policy of which location is allowed to access snapshot.
+  },
+  "storageLocation": { # Policy of which storage location is going to be resolved, and additional
+      # data that particularizes how the policy is going to be carried out.
+    "locations": { # When the policy is SPECIFIC_LOCATIONS, snapshots will be stored
+        # in the locations listed in this field. Keys are Cloud Storage bucket
+        # locations. Only one location can be specified.
+      "a_key": { # A structure for specifying storage locations.
+        "name": "A String", # Name of the location. It should be one of the Cloud Storage buckets.
+            # Only one location can be specified.
+      },
+    },
+    "policy": "A String", # The chosen location policy.
+  },
+}
+
+ +
+ patch(project, region, body=None, requestId=None, updateMask=None, x__xgafv=None) +
Patch region snapshot settings.
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, Name of the region for this request. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{
+  "accessLocation": { # (Regional snapshots use only)Policy of which location is allowed to access
+      # snapshot.
+    "locations": { # List of regions that can restore a regional
+        #  snapshot from the current region
+      "a_key": { # A structure for specifying an allowed target region.
+        "region": "A String", # Accessible region name
+      },
+    },
+    "policy": "A String", # Policy of which location is allowed to access snapshot.
+  },
+  "storageLocation": { # Policy of which storage location is going to be resolved, and additional
+      # data that particularizes how the policy is going to be carried out.
+    "locations": { # When the policy is SPECIFIC_LOCATIONS, snapshots will be stored
+        # in the locations listed in this field. Keys are Cloud Storage bucket
+        # locations. Only one location can be specified.
+      "a_key": { # A structure for specifying storage locations.
+        "name": "A String", # Name of the location. It should be one of the Cloud Storage buckets.
+            # Only one location can be specified.
+      },
+    },
+    "policy": "A String", # The chosen location policy.
+  },
+}
+
+  requestId: string, An optional request ID to identify requests. Specify a unique request ID so
+that if you must retry your request, the server will know to ignore the
+request if it has already been completed.
+
+For example, consider a situation where you make an initial request and
+the request times out. If you make the request again with the same
+request ID, the server can check if original operation with the same
+request ID was received, and if so, will ignore the second request. This
+prevents clients from accidentally creating duplicate commitments.
+
+The request ID must be
+a valid UUID with the exception that zero UUID is not supported
+(00000000-0000-0000-0000-000000000000).
+  updateMask: string, update_mask indicates fields to be updated as part of this request.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an Operation resource.
+    #
+    # Google Compute Engine has three Operation resources:
+    #
+    # * [Global](/compute/docs/reference/rest/v1/globalOperations)
+    # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
+    # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
+    #
+    # You can use an operation resource to manage asynchronous API requests.
+    # For more information, readHandling
+    # API responses.
+    #
+    # Operations can be global, regional or zonal.
+    #
+    #    - For global operations, use the `globalOperations`
+    #    resource.
+    #    - For regional operations, use the
+    #    `regionOperations` resource.
+    #    - For zonal operations, use
+    #    the `zoneOperations` resource.
+    #
+    #
+    #
+    # For more information, read
+    # Global, Regional, and Zonal Resources.
+    #
+    # Note that completed Operation resources have a limited
+    # retention period.
+  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
+      # Not present otherwise.
+  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+  "description": "A String", # [Output Only] A textual description of the operation, which is
+      # set when the operation is created.
+  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
+      # text format.
+  "error": { # [Output Only] If errors are generated during processing of the operation,
+      # this field will be populated.
+    "errors": [ # [Output Only] The array of errors encountered while processing this
+        # operation.
+      {
+        "code": "A String", # [Output Only] The error type identifier for this error.
+        "errorDetails": [ # [Output Only] An optional list of messages that contain the error
+            # details. There is a set of defined message types to use for providing
+            # details.The syntax depends on the error code. For example,
+            # QuotaExceededInfo will have details when the error code is
+            # QUOTA_EXCEEDED.
+          {
+            "errorInfo": { # Describes the cause of the error with structured details.
+                #
+                # Example of an error when contacting the "pubsub.googleapis.com" API when it
+                # is not enabled:
+                #
+                #     { "reason": "API_DISABLED"
+                #       "domain": "googleapis.com"
+                #       "metadata": {
+                #         "resource": "projects/123",
+                #         "service": "pubsub.googleapis.com"
+                #       }
+                #     }
+                #
+                # This response indicates that the pubsub.googleapis.com API is not enabled.
+                #
+                # Example of an error that is returned when attempting to create a Spanner
+                # instance in a region that is out of stock:
+                #
+                #     { "reason": "STOCKOUT"
+                #       "domain": "spanner.googleapis.com",
+                #       "metadata": {
+                #         "availableRegions": "us-central1,us-east2"
+                #       }
+                #     }
+              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+                  # is typically the registered service name of the tool or product that
+                  # generates the error. Example: "pubsub.googleapis.com". If the error is
+                  # generated by some common infrastructure, the error domain must be a
+                  # globally unique value that identifies the infrastructure. For Google API
+                  # infrastructure, the error domain is "googleapis.com".
+              "metadatas": { # Additional structured details about this error.
+                  #
+                  # Keys must match a regular expression of `a-z+` but should
+                  # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+                  # length. When identifying the current value of an exceeded limit, the units
+                  # should be contained in the key, not the value.  For example, rather than
+                  # `{"instanceLimit": "100/request"}`, should be returned as,
+                  # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+                  # instances that can be created in a single (batch) request.
+                "a_key": "A String",
+              },
+              "reason": "A String", # The reason of the error. This is a constant value that identifies the
+                  # proximate cause of the error. Error reasons are unique within a particular
+                  # domain of errors. This should be at most 63 characters and match a
+                  # regular expression of `A-Z+[A-Z0-9]`, which represents
+                  # UPPER_SNAKE_CASE.
+            },
+            "help": { # Provides links to documentation or for performing an out of band action.
+                #
+                # For example, if a quota check failed with an error indicating the calling
+                # project hasn't enabled the accessed service, this can contain a URL pointing
+                # directly to the right place in the developer console to flip the bit.
+              "links": [ # URL(s) pointing to additional information on handling the current error.
+                { # Describes a URL link.
+                  "description": "A String", # Describes what the link offers.
+                  "url": "A String", # The URL of the link.
+                },
+              ],
+            },
+            "localizedMessage": { # Provides a localized error message that is safe to return to the user
+                # which can be attached to an RPC error.
+              "locale": "A String", # The locale used following the specification defined at
+                  # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+                  # Examples are: "en-US", "fr-CH", "es-MX"
+              "message": "A String", # The localized error message in the above locale.
+            },
+            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+              "dimensions": { # The map holding related quota dimensions.
+                "a_key": "A String",
+              },
+              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+                  #  type or metric.
+              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+                  # or metric.
+              "limitName": "A String", # The name of the quota limit.
+              "metricName": "A String", # The Compute Engine quota metric name.
+              "rolloutStatus": "A String", # Rollout status of the future quota limit.
+            },
+          },
+        ],
+        "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+            # This property is optional.
+        "message": "A String", # [Output Only] An optional, human-readable error message.
+      },
+    ],
+  },
+  "getVersionOperationMetadata": {
+    "inlineSbomInfo": {
+      "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+          # name and the value is the version.
+        "a_key": "A String",
+      },
+      "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+          # component name and the value is the version.
+        "a_key": "A String",
+      },
+    },
+  },
+  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
+      # message that was returned, such as `NOT FOUND`.
+  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
+      # status code that was returned. For example, a `404` means the
+      # resource was not found.
+  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
+      # defined by the server.
+  "insertTime": "A String", # [Output Only] The time that this operation was requested.
+      # This value is inRFC3339
+      # text format.
+  "instancesBulkInsertOperationMetadata": {
+    "perLocationStatus": { # Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
+            # error.
+        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
+            # if the flow is rolling forward or rolling back.
+        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+      },
+    },
+  },
+  "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
+      # Operation resources.
+  "name": "A String", # [Output Only] Name of the operation.
+  "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
+      # group of operations results from a `bulkInsert` API request.
+  "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
+      # `update`, or `delete`, and so on.
+  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
+      # There is no requirement that this be linear or support any granularity of
+      # operations. This should not be used to guess when the operation will be
+      # complete. This number should monotonically increase as the operation
+      # progresses.
+  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
+      # applicable when performing regional operations.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
+      # this field will contain information on all underlying zonal actions and
+      # their state.
+    "clientOperationId": "A String", # [Output Only] The client operation id.
+    "perLocationOperations": { # [Output Only] Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
+            # populated.
+            # different programming environments, including REST APIs and RPC APIs. It is
+            # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+            # three pieces of data: error code, error message, and error details.
+            #
+            # You can find out more about this error model and how to work with it in the
+            # [API Design Guide](https://cloud.google.com/apis/design/errors).
+          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+          "details": [ # A list of messages that carry the error details.  There is a common set of
+              # message types for APIs to use.
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+          "message": "A String", # A developer-facing error message, which should be in English. Any
+              # user-facing error message should be localized and sent in the
+              # google.rpc.Status.details field, or localized by the client.
+        },
+        "state": "A String", # [Output Only] Status of the action, which can be one of the following:
+            # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+      },
+    },
+  },
+  "startTime": "A String", # [Output Only] The time that this operation was started by the server.
+      # This value is inRFC3339
+      # text format.
+  "status": "A String", # [Output Only] The status of the operation, which can be one of the
+      # following:
+      # `PENDING`, `RUNNING`, or `DONE`.
+  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
+      # operation.
+  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
+      # of the target resource.
+  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
+      # operations related to creating a snapshot, this points to the disk
+      # that the snapshot was created from.
+  "user": "A String", # [Output Only] User who requested the operation, for example:
+      # `user@example.com` or
+      # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+  "warnings": [ # [Output Only] If warning messages are generated during processing of the
+      # operation, this field will be populated.
+    {
+      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+          # Engine returns NO_RESULTS_ON_PAGE if there
+          # are no results in the response.
+      "data": [ # [Output Only] Metadata about this warning in key:
+          # value format. For example:
+          #
+          # "data": [
+          #   {
+          #    "key": "scope",
+          #    "value": "zones/us-east1-d"
+          #   }
+        {
+          "key": "A String", # [Output Only] A key that provides more detail on the warning being
+              # returned. For example, for warnings where there are no results in a list
+              # request for a particular zone, this key might be scope and
+              # the key value might be the zone name. Other examples might be a key
+              # indicating a deprecated resource and a suggested replacement, or a
+              # warning about invalid network settings (for example, if an instance
+              # attempts to perform IP forwarding but is not enabled for IP forwarding).
+          "value": "A String", # [Output Only] A warning data value corresponding to the key.
+        },
+      ],
+      "message": "A String", # [Output Only] A human-readable description of the warning code.
+    },
+  ],
+  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
+      # applicable when performing per-zone operations.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/compute_v1.regionSnapshots.html b/docs/dyn/compute_v1.regionSnapshots.html new file mode 100644 index 0000000000..0ee750716e --- /dev/null +++ b/docs/dyn/compute_v1.regionSnapshots.html @@ -0,0 +1,3745 @@ + + + +

Compute Engine API . regionSnapshots

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ delete(project, region, snapshot, requestId=None, x__xgafv=None)

+

Deletes the specified Snapshot resource. Keep in mind that deleting

+

+ get(project, region, snapshot, x__xgafv=None)

+

Returns the specified Snapshot resource.

+

+ getIamPolicy(project, region, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)

+

Gets the access control policy for a resource. May be empty if no such

+

+ insert(project, region, body=None, requestId=None, x__xgafv=None)

+

Creates a snapshot in the specified region using the data included

+

+ list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Retrieves the list of Snapshot resources contained within

+

+ list_next()

+

Retrieves the next page of results.

+

+ setIamPolicy(project, region, resource, body=None, x__xgafv=None)

+

Sets the access control policy on the specified resource.

+

+ setLabels(project, region, resource, body=None, requestId=None, x__xgafv=None)

+

Sets the labels on a regional snapshot. To learn more about labels, read

+

+ testIamPermissions(project, region, resource, body=None, x__xgafv=None)

+

Returns permissions that a caller has on the specified resource.

+

+ updateKmsKey(project, region, snapshot, body=None, requestId=None, x__xgafv=None)

+

Rotates the customer-managed

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ delete(project, region, snapshot, requestId=None, x__xgafv=None) +
Deletes the specified Snapshot resource. Keep in mind that deleting
+a single snapshot might not necessarily delete all the data on that
+snapshot. If any data on the snapshot that is marked for deletion is
+needed for subsequent snapshots, the data will be moved to the next
+corresponding snapshot.
+
+For more information, seeDeleting
+snapshots.
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, The name of the region for this request. (required)
+  snapshot: string, Name of the snapshot resource to delete. (required)
+  requestId: string, An optional request ID to identify requests. Specify a unique request ID so
+that if you must retry your request, the server will know to ignore the
+request if it has already been completed.
+
+For example, consider a situation where you make an initial request and
+the request times out. If you make the request again with the same
+request ID, the server can check if original operation with the same
+request ID was received, and if so, will ignore the second request. This
+prevents clients from accidentally creating duplicate commitments.
+
+The request ID must be
+a valid UUID with the exception that zero UUID is not supported
+(00000000-0000-0000-0000-000000000000).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an Operation resource.
+    #
+    # Google Compute Engine has three Operation resources:
+    #
+    # * [Global](/compute/docs/reference/rest/v1/globalOperations)
+    # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
+    # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
+    #
+    # You can use an operation resource to manage asynchronous API requests.
+    # For more information, readHandling
+    # API responses.
+    #
+    # Operations can be global, regional or zonal.
+    #
+    #    - For global operations, use the `globalOperations`
+    #    resource.
+    #    - For regional operations, use the
+    #    `regionOperations` resource.
+    #    - For zonal operations, use
+    #    the `zoneOperations` resource.
+    #
+    #
+    #
+    # For more information, read
+    # Global, Regional, and Zonal Resources.
+    #
+    # Note that completed Operation resources have a limited
+    # retention period.
+  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
+      # Not present otherwise.
+  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+  "description": "A String", # [Output Only] A textual description of the operation, which is
+      # set when the operation is created.
+  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
+      # text format.
+  "error": { # [Output Only] If errors are generated during processing of the operation,
+      # this field will be populated.
+    "errors": [ # [Output Only] The array of errors encountered while processing this
+        # operation.
+      {
+        "code": "A String", # [Output Only] The error type identifier for this error.
+        "errorDetails": [ # [Output Only] An optional list of messages that contain the error
+            # details. There is a set of defined message types to use for providing
+            # details.The syntax depends on the error code. For example,
+            # QuotaExceededInfo will have details when the error code is
+            # QUOTA_EXCEEDED.
+          {
+            "errorInfo": { # Describes the cause of the error with structured details.
+                #
+                # Example of an error when contacting the "pubsub.googleapis.com" API when it
+                # is not enabled:
+                #
+                #     { "reason": "API_DISABLED"
+                #       "domain": "googleapis.com"
+                #       "metadata": {
+                #         "resource": "projects/123",
+                #         "service": "pubsub.googleapis.com"
+                #       }
+                #     }
+                #
+                # This response indicates that the pubsub.googleapis.com API is not enabled.
+                #
+                # Example of an error that is returned when attempting to create a Spanner
+                # instance in a region that is out of stock:
+                #
+                #     { "reason": "STOCKOUT"
+                #       "domain": "spanner.googleapis.com",
+                #       "metadata": {
+                #         "availableRegions": "us-central1,us-east2"
+                #       }
+                #     }
+              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+                  # is typically the registered service name of the tool or product that
+                  # generates the error. Example: "pubsub.googleapis.com". If the error is
+                  # generated by some common infrastructure, the error domain must be a
+                  # globally unique value that identifies the infrastructure. For Google API
+                  # infrastructure, the error domain is "googleapis.com".
+              "metadatas": { # Additional structured details about this error.
+                  #
+                  # Keys must match a regular expression of `a-z+` but should
+                  # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+                  # length. When identifying the current value of an exceeded limit, the units
+                  # should be contained in the key, not the value.  For example, rather than
+                  # `{"instanceLimit": "100/request"}`, should be returned as,
+                  # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+                  # instances that can be created in a single (batch) request.
+                "a_key": "A String",
+              },
+              "reason": "A String", # The reason of the error. This is a constant value that identifies the
+                  # proximate cause of the error. Error reasons are unique within a particular
+                  # domain of errors. This should be at most 63 characters and match a
+                  # regular expression of `A-Z+[A-Z0-9]`, which represents
+                  # UPPER_SNAKE_CASE.
+            },
+            "help": { # Provides links to documentation or for performing an out of band action.
+                #
+                # For example, if a quota check failed with an error indicating the calling
+                # project hasn't enabled the accessed service, this can contain a URL pointing
+                # directly to the right place in the developer console to flip the bit.
+              "links": [ # URL(s) pointing to additional information on handling the current error.
+                { # Describes a URL link.
+                  "description": "A String", # Describes what the link offers.
+                  "url": "A String", # The URL of the link.
+                },
+              ],
+            },
+            "localizedMessage": { # Provides a localized error message that is safe to return to the user
+                # which can be attached to an RPC error.
+              "locale": "A String", # The locale used following the specification defined at
+                  # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+                  # Examples are: "en-US", "fr-CH", "es-MX"
+              "message": "A String", # The localized error message in the above locale.
+            },
+            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+              "dimensions": { # The map holding related quota dimensions.
+                "a_key": "A String",
+              },
+              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+                  #  type or metric.
+              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+                  # or metric.
+              "limitName": "A String", # The name of the quota limit.
+              "metricName": "A String", # The Compute Engine quota metric name.
+              "rolloutStatus": "A String", # Rollout status of the future quota limit.
+            },
+          },
+        ],
+        "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+            # This property is optional.
+        "message": "A String", # [Output Only] An optional, human-readable error message.
+      },
+    ],
+  },
+  "getVersionOperationMetadata": {
+    "inlineSbomInfo": {
+      "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+          # name and the value is the version.
+        "a_key": "A String",
+      },
+      "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+          # component name and the value is the version.
+        "a_key": "A String",
+      },
+    },
+  },
+  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
+      # message that was returned, such as `NOT FOUND`.
+  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
+      # status code that was returned. For example, a `404` means the
+      # resource was not found.
+  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
+      # defined by the server.
+  "insertTime": "A String", # [Output Only] The time that this operation was requested.
+      # This value is inRFC3339
+      # text format.
+  "instancesBulkInsertOperationMetadata": {
+    "perLocationStatus": { # Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
+            # error.
+        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
+            # if the flow is rolling forward or rolling back.
+        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+      },
+    },
+  },
+  "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
+      # Operation resources.
+  "name": "A String", # [Output Only] Name of the operation.
+  "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
+      # group of operations results from a `bulkInsert` API request.
+  "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
+      # `update`, or `delete`, and so on.
+  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
+      # There is no requirement that this be linear or support any granularity of
+      # operations. This should not be used to guess when the operation will be
+      # complete. This number should monotonically increase as the operation
+      # progresses.
+  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
+      # applicable when performing regional operations.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
+      # this field will contain information on all underlying zonal actions and
+      # their state.
+    "clientOperationId": "A String", # [Output Only] The client operation id.
+    "perLocationOperations": { # [Output Only] Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
+            # populated.
+            # different programming environments, including REST APIs and RPC APIs. It is
+            # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+            # three pieces of data: error code, error message, and error details.
+            #
+            # You can find out more about this error model and how to work with it in the
+            # [API Design Guide](https://cloud.google.com/apis/design/errors).
+          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+          "details": [ # A list of messages that carry the error details.  There is a common set of
+              # message types for APIs to use.
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+          "message": "A String", # A developer-facing error message, which should be in English. Any
+              # user-facing error message should be localized and sent in the
+              # google.rpc.Status.details field, or localized by the client.
+        },
+        "state": "A String", # [Output Only] Status of the action, which can be one of the following:
+            # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+      },
+    },
+  },
+  "startTime": "A String", # [Output Only] The time that this operation was started by the server.
+      # This value is inRFC3339
+      # text format.
+  "status": "A String", # [Output Only] The status of the operation, which can be one of the
+      # following:
+      # `PENDING`, `RUNNING`, or `DONE`.
+  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
+      # operation.
+  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
+      # of the target resource.
+  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
+      # operations related to creating a snapshot, this points to the disk
+      # that the snapshot was created from.
+  "user": "A String", # [Output Only] User who requested the operation, for example:
+      # `user@example.com` or
+      # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+  "warnings": [ # [Output Only] If warning messages are generated during processing of the
+      # operation, this field will be populated.
+    {
+      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+          # Engine returns NO_RESULTS_ON_PAGE if there
+          # are no results in the response.
+      "data": [ # [Output Only] Metadata about this warning in key:
+          # value format. For example:
+          #
+          # "data": [
+          #   {
+          #    "key": "scope",
+          #    "value": "zones/us-east1-d"
+          #   }
+        {
+          "key": "A String", # [Output Only] A key that provides more detail on the warning being
+              # returned. For example, for warnings where there are no results in a list
+              # request for a particular zone, this key might be scope and
+              # the key value might be the zone name. Other examples might be a key
+              # indicating a deprecated resource and a suggested replacement, or a
+              # warning about invalid network settings (for example, if an instance
+              # attempts to perform IP forwarding but is not enabled for IP forwarding).
+          "value": "A String", # [Output Only] A warning data value corresponding to the key.
+        },
+      ],
+      "message": "A String", # [Output Only] A human-readable description of the warning code.
+    },
+  ],
+  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
+      # applicable when performing per-zone operations.
+}
+
+ +
+ get(project, region, snapshot, x__xgafv=None) +
Returns the specified Snapshot resource.
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, Name of the region for this request. (required)
+  snapshot: string, Name of the Snapshot resource to return. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents a Persistent Disk Snapshot resource.
+    #
+    # You can use snapshots to back up data on a regular interval. For more
+    # information, read  Creating
+    # persistent disk snapshots.
+  "architecture": "A String", # Output only. [Output Only] The architecture of the snapshot. Valid values are
+      # ARM64 or X86_64.
+  "autoCreated": True or False, # Output only. [Output Only] Set to true if snapshots are automatically created by
+      # applying resource policy on the target disk.
+  "chainName": "A String", # Creates the new snapshot in the snapshot chain labeled with the
+      # specified name. The chain name must be 1-63 characters long and comply
+      # with RFC1035. This is an uncommon option only for advanced service
+      # owners who needs to create separate snapshot chains, for example,
+      # for chargeback tracking. When you describe your snapshot resource, this
+      # field is visible only if it has a non-empty value.
+  "creationSizeBytes": "A String", # Output only. [Output Only] Size in bytes of the snapshot at creation time.
+  "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339
+      # text format.
+  "description": "A String", # An optional description of this resource. Provide this property when you
+      # create the resource.
+  "diskSizeGb": "A String", # Output only. [Output Only] Size of the source disk, specified in GB.
+  "downloadBytes": "A String", # Output only. [Output Only] Number of bytes downloaded to restore a snapshot to a disk.
+  "enableConfidentialCompute": True or False, # Output only. Whether this snapshot is created from a confidential compute mode disk.
+      # [Output Only]: This field is not set by user, but from source disk.
+  "guestFlush": True or False, # [Input Only] Whether to attempt an application consistent snapshot by
+      # informing the OS to prepare for the snapshot process.
+  "guestOsFeatures": [ # Output only. [Output Only] A list of features to enable on the guest operating system.
+      # Applicable only for bootable images. Read
+      # Enabling guest operating system features to see a list of available
+      # options.
+    { # Guest OS features.
+      "type": "A String", # The ID of a supported feature. To add multiple values, use commas to
+          # separate values. Set to one or more of the following values:
+          #
+          #    - VIRTIO_SCSI_MULTIQUEUE
+          #    - WINDOWS
+          #    - MULTI_IP_SUBNET
+          #    - UEFI_COMPATIBLE
+          #    - GVNIC
+          #    - SEV_CAPABLE
+          #    - SUSPEND_RESUME_COMPATIBLE
+          #    - SEV_LIVE_MIGRATABLE_V2
+          #    - SEV_SNP_CAPABLE
+          #    - TDX_CAPABLE
+          #    - IDPF
+          #    - SNP_SVSM_CAPABLE
+          #    - CCA_CAPABLE
+          #
+          #
+          # For more information, see
+          # Enabling guest operating system features.
+    },
+  ],
+  "id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is
+      # defined by the server.
+  "kind": "compute#snapshot", # Output only. [Output Only] Type of the resource. Always compute#snapshot
+      # for Snapshot resources.
+  "labelFingerprint": "A String", # A fingerprint for the labels being applied to this snapshot, which is
+      # essentially a hash of the labels set used for optimistic locking. The
+      # fingerprint is initially generated by Compute Engine and changes after
+      # every request to modify or update labels. You must always provide an
+      # up-to-date fingerprint hash in order to update or change labels,
+      # otherwise the request will fail with error412 conditionNotMet.
+      #
+      # To see the latest fingerprint, make a get() request to
+      # retrieve a snapshot.
+  "labels": { # Labels to apply to this snapshot. These can be later modified by
+      # the setLabels method.
+      # Label values may be empty.
+    "a_key": "A String",
+  },
+  "licenseCodes": [ # Output only. [Output Only] Integer license codes indicating which licenses are attached
+      # to this snapshot.
+    "A String",
+  ],
+  "licenses": [ # Output only. [Output Only] A list of public visible licenses that apply to this
+      # snapshot. This can be because the original image had licenses attached
+      # (such as a Windows image).
+    "A String",
+  ],
+  "locationHint": "A String", # An opaque location hint used to place the snapshot close to other
+      # resources.
+      # This field is for use by internal tools that use the public API.
+  "name": "A String", # Name of the resource; provided by the client when the resource is created.
+      # The name must be 1-63 characters long, and comply withRFC1035.
+      # Specifically, the name must be 1-63 characters long and match the regular
+      # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
+      # character must be a lowercase letter, and all following characters must be
+      # a dash, lowercase letter, or digit, except the last character, which cannot
+      # be a dash.
+  "params": { # Additional snapshot params. # Input only. [Input Only] Additional params passed with the request, but not persisted
+      # as part of resource payload.
+    "resourceManagerTags": { # Input only. Resource manager tags to be bound to the snapshot. Tag keys and values have
+        # the same definition as resource
+        # manager tags. Keys and values can be either in numeric format,
+        # such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
+        # format such as `{org_id|project_id}/{tag_key_short_name}` and
+        # `{tag_value_short_name}`. The field is ignored (both PUT &
+        # PATCH) when empty.
+      "a_key": "A String",
+    },
+  },
+  "region": "A String", # Output only. [Output Only] URL of the region where the snapshot resides. Only applicable
+      # for regional snapshots.
+  "satisfiesPzi": True or False, # Output only. Reserved for future use.
+  "satisfiesPzs": True or False, # Output only. [Output Only] Reserved for future use.
+  "selfLink": "A String", # Output only. [Output Only] Server-defined URL for the resource.
+  "snapshotEncryptionKey": { # Encrypts the snapshot using acustomer-supplied
+      # encryption key.
+      #
+      # After you encrypt a snapshot using a customer-supplied key, you must
+      # provide the same key if you use the snapshot later. For example, you must
+      # provide the encryption key when you create a disk from the encrypted
+      # snapshot in a future request.
+      #
+      # Customer-supplied encryption keys do not protect access to metadata
+      # of the snapshot.
+      #
+      # If you do not provide an encryption key when creating the snapshot, then
+      # the snapshot will be encrypted using an automatically generated key and you
+      # do not need to provide a key to use the snapshot later.
+    "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
+        # For example:
+        #
+        # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+        # key_region/cryptoKeys/key
+        #
+        # The fully-qualifed key name may be returned for resource GET requests. For
+        # example:
+        #
+        # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+        # key_region/cryptoKeys/key
+        # /cryptoKeyVersions/1
+    "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
+        # key. If absent, the Compute Engine default service account is used.
+        # For example:
+        #
+        # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
+    "rawKey": "A String", # Specifies a 256-bit customer-supplied
+        # encryption key, encoded in RFC
+        # 4648 base64 to either encrypt or decrypt this resource. You can
+        # provide either the rawKey or thersaEncryptedKey.
+        # For example:
+        #
+        # "rawKey":
+        # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
+    "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
+        # customer-supplied encryption key to either encrypt or decrypt this
+        # resource. You can provide either the rawKey or thersaEncryptedKey.
+        # For example:
+        #
+        # "rsaEncryptedKey":
+        # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
+        # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
+        # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
+        #
+        # The key must meet the following requirements before you can provide it to
+        # Compute Engine:
+        #
+        #    1. The key is wrapped using a RSA public key certificate provided by
+        #    Google.
+        #    2. After being wrapped, the key must be encoded in RFC 4648 base64
+        #    encoding.
+        #
+        # Gets the RSA public key certificate provided by Google at:
+        #
+        #
+        # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+    "sha256": "A String", # [Output only] TheRFC
+        # 4648 base64 encoded SHA-256 hash of the customer-supplied
+        # encryption key that protects this resource.
+  },
+  "snapshotGroupId": "A String", # Output only. [Output Only] The unique ID of the snapshot group that this snapshot
+      # belongs to. The usage of snapshot group feature is restricted.
+  "snapshotGroupName": "A String", # Output only. [Output only] The snapshot group that this snapshot belongs to. The usage
+      # of snapshot group feature is restricted.
+  "snapshotType": "A String", # Indicates the type of the snapshot.
+  "sourceDisk": "A String", # The source disk used to create this snapshot.
+  "sourceDiskEncryptionKey": { # The customer-supplied
+      # encryption key of the source disk. Required if the source disk is
+      # protected by a customer-supplied encryption key.
+    "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
+        # For example:
+        #
+        # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+        # key_region/cryptoKeys/key
+        #
+        # The fully-qualifed key name may be returned for resource GET requests. For
+        # example:
+        #
+        # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+        # key_region/cryptoKeys/key
+        # /cryptoKeyVersions/1
+    "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
+        # key. If absent, the Compute Engine default service account is used.
+        # For example:
+        #
+        # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
+    "rawKey": "A String", # Specifies a 256-bit customer-supplied
+        # encryption key, encoded in RFC
+        # 4648 base64 to either encrypt or decrypt this resource. You can
+        # provide either the rawKey or thersaEncryptedKey.
+        # For example:
+        #
+        # "rawKey":
+        # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
+    "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
+        # customer-supplied encryption key to either encrypt or decrypt this
+        # resource. You can provide either the rawKey or thersaEncryptedKey.
+        # For example:
+        #
+        # "rsaEncryptedKey":
+        # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
+        # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
+        # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
+        #
+        # The key must meet the following requirements before you can provide it to
+        # Compute Engine:
+        #
+        #    1. The key is wrapped using a RSA public key certificate provided by
+        #    Google.
+        #    2. After being wrapped, the key must be encoded in RFC 4648 base64
+        #    encoding.
+        #
+        # Gets the RSA public key certificate provided by Google at:
+        #
+        #
+        # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+    "sha256": "A String", # [Output only] TheRFC
+        # 4648 base64 encoded SHA-256 hash of the customer-supplied
+        # encryption key that protects this resource.
+  },
+  "sourceDiskForRecoveryCheckpoint": "A String", # The source disk whose recovery checkpoint will be used to create this
+      # snapshot.
+  "sourceDiskId": "A String", # Output only. [Output Only] The ID value of the disk used to create this snapshot. This
+      # value may be used to determine whether the snapshot was taken from the
+      # current or a previous instance of a given disk name.
+  "sourceInstantSnapshot": "A String", # The source instant snapshot used to create this snapshot. You can provide
+      # this as a partial or full URL to the resource. For example, the following
+      # are valid values:
+      #
+      #
+      #      - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instantSnapshots/instantSnapshot
+      #      - projects/project/zones/zone/instantSnapshots/instantSnapshot
+      #    - zones/zone/instantSnapshots/instantSnapshot
+  "sourceInstantSnapshotEncryptionKey": { # Customer provided encryption key when creating Snapshot from Instant
+      # Snapshot.
+    "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
+        # For example:
+        #
+        # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+        # key_region/cryptoKeys/key
+        #
+        # The fully-qualifed key name may be returned for resource GET requests. For
+        # example:
+        #
+        # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+        # key_region/cryptoKeys/key
+        # /cryptoKeyVersions/1
+    "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
+        # key. If absent, the Compute Engine default service account is used.
+        # For example:
+        #
+        # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
+    "rawKey": "A String", # Specifies a 256-bit customer-supplied
+        # encryption key, encoded in RFC
+        # 4648 base64 to either encrypt or decrypt this resource. You can
+        # provide either the rawKey or thersaEncryptedKey.
+        # For example:
+        #
+        # "rawKey":
+        # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
+    "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
+        # customer-supplied encryption key to either encrypt or decrypt this
+        # resource. You can provide either the rawKey or thersaEncryptedKey.
+        # For example:
+        #
+        # "rsaEncryptedKey":
+        # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
+        # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
+        # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
+        #
+        # The key must meet the following requirements before you can provide it to
+        # Compute Engine:
+        #
+        #    1. The key is wrapped using a RSA public key certificate provided by
+        #    Google.
+        #    2. After being wrapped, the key must be encoded in RFC 4648 base64
+        #    encoding.
+        #
+        # Gets the RSA public key certificate provided by Google at:
+        #
+        #
+        # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+    "sha256": "A String", # [Output only] TheRFC
+        # 4648 base64 encoded SHA-256 hash of the customer-supplied
+        # encryption key that protects this resource.
+  },
+  "sourceInstantSnapshotId": "A String", # Output only. [Output Only] The unique ID of the instant snapshot used to create this
+      # snapshot. This value identifies the exact instant snapshot that was used to
+      # create this snapshot. For example, if you created the snapshot from an
+      # instant snapshot that was later deleted and recreated under the same name,
+      # the source instant snapshot ID would identify the exact instant snapshot
+      # that was used.
+  "sourceSnapshotSchedulePolicy": "A String", # Output only. [Output Only] URL of the resource policy which created this
+      # scheduled snapshot.
+  "sourceSnapshotSchedulePolicyId": "A String", # Output only. [Output Only] ID of the resource policy which created this
+      # scheduled snapshot.
+  "status": "A String", # Output only. [Output Only] The status of the snapshot. This can beCREATING, DELETING, FAILED,READY, or UPLOADING.
+  "storageBytes": "A String", # Output only. [Output Only] A size of the storage used by the snapshot. As snapshots
+      # share storage, this number is expected to change with snapshot
+      # creation/deletion.
+  "storageBytesStatus": "A String", # Output only. [Output Only] An indicator whether storageBytes is in a
+      # stable state or it is being adjusted as a result of shared storage
+      # reallocation. This status can either be UPDATING, meaning
+      # the size of the snapshot is being updated, or UP_TO_DATE,
+      # meaning the size of the snapshot is up-to-date.
+  "storageLocations": [ # Cloud Storage bucket storage location of the snapshot (regional or
+      # multi-regional).
+    "A String",
+  ],
+}
+
+ +
+ getIamPolicy(project, region, resource, optionsRequestedPolicyVersion=None, x__xgafv=None) +
Gets the access control policy for a resource. May be empty if no such
+policy or resource exists.
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, The name of the region for this request. (required)
+  resource: string, Name or id of the resource for this request. (required)
+  optionsRequestedPolicyVersion: integer, Requested IAM Policy version.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An Identity and Access Management (IAM) policy, which specifies access
+    # controls for Google Cloud resources.
+    #
+    #
+    # A `Policy` is a collection of `bindings`. A `binding` binds one or more
+    # `members`, or principals, to a single `role`. Principals can be user
+    # accounts, service accounts, Google groups, and domains (such as G Suite). A
+    # `role` is a named list of permissions; each `role` can be an IAM predefined
+    # role or a user-created custom role.
+    #
+    # For some types of Google Cloud resources, a `binding` can also specify a
+    # `condition`, which is a logical expression that allows access to a resource
+    # only if the expression evaluates to `true`. A condition can add constraints
+    # based on attributes of the request, the resource, or both. To learn which
+    # resources support conditions in their IAM policies, see the
+    # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+    #
+    # **JSON example:**
+    #
+    # ```
+    #     {
+    #       "bindings": [
+    #         {
+    #           "role": "roles/resourcemanager.organizationAdmin",
+    #           "members": [
+    #             "user:mike@example.com",
+    #             "group:admins@example.com",
+    #             "domain:google.com",
+    #             "serviceAccount:my-project-id@appspot.gserviceaccount.com"
+    #           ]
+    #         },
+    #         {
+    #           "role": "roles/resourcemanager.organizationViewer",
+    #           "members": [
+    #             "user:eve@example.com"
+    #           ],
+    #           "condition": {
+    #             "title": "expirable access",
+    #             "description": "Does not grant access after Sep 2020",
+    #             "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
+    #           }
+    #         }
+    #       ],
+    #       "etag": "BwWWja0YfJA=",
+    #       "version": 3
+    #     }
+    # ```
+    #
+    # **YAML example:**
+    #
+    # ```
+    #     bindings:
+    #     - members:
+    #       - user:mike@example.com
+    #       - group:admins@example.com
+    #       - domain:google.com
+    #       - serviceAccount:my-project-id@appspot.gserviceaccount.com
+    #       role: roles/resourcemanager.organizationAdmin
+    #     - members:
+    #       - user:eve@example.com
+    #       role: roles/resourcemanager.organizationViewer
+    #       condition:
+    #         title: expirable access
+    #         description: Does not grant access after Sep 2020
+    #         expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
+    #     etag: BwWWja0YfJA=
+    #     version: 3
+    # ```
+    #
+    # For a description of IAM and its features, see the
+    # [IAM documentation](https://cloud.google.com/iam/docs/).
+  "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+    { # Specifies the audit configuration for a service.
+        # The configuration determines which permission types are logged, and what
+        # identities, if any, are exempted from logging.
+        # An AuditConfig must have one or more AuditLogConfigs.
+        #
+        # If there are AuditConfigs for both `allServices` and a specific service,
+        # the union of the two AuditConfigs is used for that service: the log_types
+        # specified in each AuditConfig are enabled, and the exempted_members in each
+        # AuditLogConfig are exempted.
+        #
+        # Example Policy with multiple AuditConfigs:
+        #
+        #     {
+        #       "audit_configs": [
+        #         {
+        #           "service": "allServices",
+        #           "audit_log_configs": [
+        #             {
+        #               "log_type": "DATA_READ",
+        #               "exempted_members": [
+        #                 "user:jose@example.com"
+        #               ]
+        #             },
+        #             {
+        #               "log_type": "DATA_WRITE"
+        #             },
+        #             {
+        #               "log_type": "ADMIN_READ"
+        #             }
+        #           ]
+        #         },
+        #         {
+        #           "service": "sampleservice.googleapis.com",
+        #           "audit_log_configs": [
+        #             {
+        #               "log_type": "DATA_READ"
+        #             },
+        #             {
+        #               "log_type": "DATA_WRITE",
+        #               "exempted_members": [
+        #                 "user:aliya@example.com"
+        #               ]
+        #             }
+        #           ]
+        #         }
+        #       ]
+        #     }
+        #
+        # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
+        # logging. It also exempts `jose@example.com` from DATA_READ logging, and
+        # `aliya@example.com` from DATA_WRITE logging.
+      "auditLogConfigs": [ # The configuration for logging of each type of permission.
+        { # Provides the configuration for logging a type of permissions.
+            # Example:
+            #
+            #     {
+            #       "audit_log_configs": [
+            #         {
+            #           "log_type": "DATA_READ",
+            #           "exempted_members": [
+            #             "user:jose@example.com"
+            #           ]
+            #         },
+            #         {
+            #           "log_type": "DATA_WRITE"
+            #         }
+            #       ]
+            #     }
+            #
+            # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
+            # jose@example.com from DATA_READ logging.
+          "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
+              # permission.
+              # Follows the same format of Binding.members.
+            "A String",
+          ],
+          "logType": "A String", # The log type that this config enables.
+        },
+      ],
+      "service": "A String", # Specifies a service that will be enabled for audit logging.
+          # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
+          # `allServices` is a special value that covers all services.
+    },
+  ],
+  "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally,
+      # may specify a `condition` that determines how and when the `bindings` are
+      # applied. Each of the `bindings` must contain at least one principal.
+      #
+      # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
+      # of these principals can be Google groups. Each occurrence of a principal
+      # counts towards these limits. For example, if the `bindings` grant 50
+      # different roles to `user:alice@example.com`, and not to any other
+      # principal, then you can add another 1,450 principals to the `bindings` in
+      # the `Policy`.
+    { # Associates `members`, or principals, with a `role`.
+      "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
+          #
+          # If the condition evaluates to `true`, then this binding applies to the
+          # current request.
+          #
+          # If the condition evaluates to `false`, then this binding does not apply to
+          # the current request. However, a different role binding might grant the same
+          # role to one or more of the principals in this binding.
+          #
+          # To learn which resources support conditions in their IAM policies, see the
+          # [IAM
+          # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+          # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
+          # are documented at https://github.com/google/cel-spec.
+          #
+          # Example (Comparison):
+          #
+          #     title: "Summary size limit"
+          #     description: "Determines if a summary is less than 100 chars"
+          #     expression: "document.summary.size() < 100"
+          #
+          # Example (Equality):
+          #
+          #     title: "Requestor is owner"
+          #     description: "Determines if requestor is the document owner"
+          #     expression: "document.owner == request.auth.claims.email"
+          #
+          # Example (Logic):
+          #
+          #     title: "Public documents"
+          #     description: "Determine whether the document should be publicly visible"
+          #     expression: "document.type != 'private' && document.type != 'internal'"
+          #
+          # Example (Data Manipulation):
+          #
+          #     title: "Notification string"
+          #     description: "Create a notification string with a timestamp."
+          #     expression: "'New message received at ' + string(document.create_time)"
+          #
+          # The exact variables and functions that may be referenced within an expression
+          # are determined by the service that evaluates it. See the service
+          # documentation for additional information.
+        "description": "A String", # Optional. Description of the expression. This is a longer text which
+            # describes the expression, e.g. when hovered over it in a UI.
+        "expression": "A String", # Textual representation of an expression in Common Expression Language
+            # syntax.
+        "location": "A String", # Optional. String indicating the location of the expression for error
+            # reporting, e.g. a file name and a position in the file.
+        "title": "A String", # Optional. Title for the expression, i.e. a short string describing
+            # its purpose. This can be used e.g. in UIs which allow to enter the
+            # expression.
+      },
+      "members": [ # Specifies the principals requesting access for a Google Cloud resource.
+          # `members` can have the following values:
+          #
+          # * `allUsers`: A special identifier that represents anyone who is
+          #    on the internet; with or without a Google account.
+          #
+          # * `allAuthenticatedUsers`: A special identifier that represents anyone
+          #    who is authenticated with a Google account or a service account.
+          #    Does not include identities that come from external identity providers
+          #    (IdPs) through identity federation.
+          #
+          # * `user:{emailid}`: An email address that represents a specific Google
+          #    account. For example, `alice@example.com` .
+          #
+          #
+          # * `serviceAccount:{emailid}`: An email address that represents a Google
+          #    service account. For example,
+          #    `my-other-app@appspot.gserviceaccount.com`.
+          #
+          # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
+          #    identifier for a
+          #    [Kubernetes service
+          #    account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
+          #    For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
+          #
+          # * `group:{emailid}`: An email address that represents a Google group.
+          #    For example, `admins@example.com`.
+          #
+          #
+          # * `domain:{domain}`: The G Suite domain (primary) that represents all the
+          #    users of that domain. For example, `google.com` or `example.com`.
+          #
+          #
+          #
+          #
+          # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
+          #   A single identity in a workforce identity pool.
+          #
+          # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
+          #   All workforce identities in a group.
+          #
+          # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
+          #   All workforce identities with a specific attribute value.
+          #
+          # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
+          #   All identities in a workforce identity pool.
+          #
+          # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
+          #   A single identity in a workload identity pool.
+          #
+          # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
+          #   A workload identity pool group.
+          #
+          # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
+          #   All identities in a workload identity pool with a certain attribute.
+          #
+          # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
+          #   All identities in a workload identity pool.
+          #
+          # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
+          #    identifier) representing a user that has been recently deleted. For
+          #    example, `alice@example.com?uid=123456789012345678901`. If the user is
+          #    recovered, this value reverts to `user:{emailid}` and the recovered user
+          #    retains the role in the binding.
+          #
+          # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
+          #    unique identifier) representing a service account that has been recently
+          #    deleted. For example,
+          #    `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
+          #    If the service account is undeleted, this value reverts to
+          #    `serviceAccount:{emailid}` and the undeleted service account retains the
+          #    role in the binding.
+          #
+          # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
+          #    identifier) representing a Google group that has been recently
+          #    deleted. For example, `admins@example.com?uid=123456789012345678901`. If
+          #    the group is recovered, this value reverts to `group:{emailid}` and the
+          #    recovered group retains the role in the binding.
+          #
+          # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
+          #   Deleted single identity in a workforce identity pool. For example,
+          #   `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+        "A String",
+      ],
+      "role": "A String", # Role that is assigned to the list of `members`, or principals.
+          # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+          #
+          # For an overview of the IAM roles and permissions, see the
+          # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
+          # a list of the available pre-defined roles, see
+          # [here](https://cloud.google.com/iam/docs/understanding-roles).
+    },
+  ],
+  "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
+      # prevent simultaneous updates of a policy from overwriting each other.
+      # It is strongly suggested that systems make use of the `etag` in the
+      # read-modify-write cycle to perform policy updates in order to avoid race
+      # conditions: An `etag` is returned in the response to `getIamPolicy`, and
+      # systems are expected to put that etag in the request to `setIamPolicy` to
+      # ensure that their change will be applied to the same version of the policy.
+      #
+      # **Important:** If you use IAM Conditions, you must include the `etag` field
+      # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+      # you to overwrite a version `3` policy with a version `1` policy, and all of
+      # the conditions in the version `3` policy are lost.
+  "version": 42, # Specifies the format of the policy.
+      #
+      # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
+      # are rejected.
+      #
+      # Any operation that affects conditional role bindings must specify version
+      # `3`. This requirement applies to the following operations:
+      #
+      # * Getting a policy that includes a conditional role binding
+      # * Adding a conditional role binding to a policy
+      # * Changing a conditional role binding in a policy
+      # * Removing any role binding, with or without a condition, from a policy
+      #   that includes conditions
+      #
+      # **Important:** If you use IAM Conditions, you must include the `etag` field
+      # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+      # you to overwrite a version `3` policy with a version `1` policy, and all of
+      # the conditions in the version `3` policy are lost.
+      #
+      # If a policy does not include any conditions, operations on that policy may
+      # specify any valid version or leave the field unset.
+      #
+      # To learn which resources support conditions in their IAM policies, see the
+      # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+}
+
+ +
+ insert(project, region, body=None, requestId=None, x__xgafv=None) +
Creates a snapshot in the specified region using the data included
+in the request.
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, Name of the region for this request. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Represents a Persistent Disk Snapshot resource.
+    # 
+    # You can use snapshots to back up data on a regular interval. For more
+    # information, read  Creating
+    # persistent disk snapshots.
+  "architecture": "A String", # Output only. [Output Only] The architecture of the snapshot. Valid values are
+      # ARM64 or X86_64.
+  "autoCreated": True or False, # Output only. [Output Only] Set to true if snapshots are automatically created by
+      # applying resource policy on the target disk.
+  "chainName": "A String", # Creates the new snapshot in the snapshot chain labeled with the
+      # specified name. The chain name must be 1-63 characters long and comply
+      # with RFC1035. This is an uncommon option only for advanced service
+      # owners who needs to create separate snapshot chains, for example,
+      # for chargeback tracking. When you describe your snapshot resource, this
+      # field is visible only if it has a non-empty value.
+  "creationSizeBytes": "A String", # Output only. [Output Only] Size in bytes of the snapshot at creation time.
+  "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339
+      # text format.
+  "description": "A String", # An optional description of this resource. Provide this property when you
+      # create the resource.
+  "diskSizeGb": "A String", # Output only. [Output Only] Size of the source disk, specified in GB.
+  "downloadBytes": "A String", # Output only. [Output Only] Number of bytes downloaded to restore a snapshot to a disk.
+  "enableConfidentialCompute": True or False, # Output only. Whether this snapshot is created from a confidential compute mode disk.
+      # [Output Only]: This field is not set by user, but from source disk.
+  "guestFlush": True or False, # [Input Only] Whether to attempt an application consistent snapshot by
+      # informing the OS to prepare for the snapshot process.
+  "guestOsFeatures": [ # Output only. [Output Only] A list of features to enable on the guest operating system.
+      # Applicable only for bootable images. Read
+      # Enabling guest operating system features to see a list of available
+      # options.
+    { # Guest OS features.
+      "type": "A String", # The ID of a supported feature. To add multiple values, use commas to
+          # separate values. Set to one or more of the following values:
+          #
+          #    - VIRTIO_SCSI_MULTIQUEUE
+          #    - WINDOWS
+          #    - MULTI_IP_SUBNET
+          #    - UEFI_COMPATIBLE
+          #    - GVNIC
+          #    - SEV_CAPABLE
+          #    - SUSPEND_RESUME_COMPATIBLE
+          #    - SEV_LIVE_MIGRATABLE_V2
+          #    - SEV_SNP_CAPABLE
+          #    - TDX_CAPABLE
+          #    - IDPF
+          #    - SNP_SVSM_CAPABLE
+          #    - CCA_CAPABLE
+          #
+          #
+          # For more information, see
+          # Enabling guest operating system features.
+    },
+  ],
+  "id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is
+      # defined by the server.
+  "kind": "compute#snapshot", # Output only. [Output Only] Type of the resource. Always compute#snapshot
+      # for Snapshot resources.
+  "labelFingerprint": "A String", # A fingerprint for the labels being applied to this snapshot, which is
+      # essentially a hash of the labels set used for optimistic locking. The
+      # fingerprint is initially generated by Compute Engine and changes after
+      # every request to modify or update labels. You must always provide an
+      # up-to-date fingerprint hash in order to update or change labels,
+      # otherwise the request will fail with error412 conditionNotMet.
+      # 
+      # To see the latest fingerprint, make a get() request to
+      # retrieve a snapshot.
+  "labels": { # Labels to apply to this snapshot. These can be later modified by
+      # the setLabels method.
+      # Label values may be empty.
+    "a_key": "A String",
+  },
+  "licenseCodes": [ # Output only. [Output Only] Integer license codes indicating which licenses are attached
+      # to this snapshot.
+    "A String",
+  ],
+  "licenses": [ # Output only. [Output Only] A list of public visible licenses that apply to this
+      # snapshot. This can be because the original image had licenses attached
+      # (such as a Windows image).
+    "A String",
+  ],
+  "locationHint": "A String", # An opaque location hint used to place the snapshot close to other
+      # resources.
+      # This field is for use by internal tools that use the public API.
+  "name": "A String", # Name of the resource; provided by the client when the resource is created.
+      # The name must be 1-63 characters long, and comply withRFC1035.
+      # Specifically, the name must be 1-63 characters long and match the regular
+      # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
+      # character must be a lowercase letter, and all following characters must be
+      # a dash, lowercase letter, or digit, except the last character, which cannot
+      # be a dash.
+  "params": { # Additional snapshot params. # Input only. [Input Only] Additional params passed with the request, but not persisted
+      # as part of resource payload.
+    "resourceManagerTags": { # Input only. Resource manager tags to be bound to the snapshot. Tag keys and values have
+        # the same definition as resource
+        # manager tags. Keys and values can be either in numeric format,
+        # such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
+        # format such as `{org_id|project_id}/{tag_key_short_name}` and
+        # `{tag_value_short_name}`. The field is ignored (both PUT &
+        # PATCH) when empty.
+      "a_key": "A String",
+    },
+  },
+  "region": "A String", # Output only. [Output Only] URL of the region where the snapshot resides. Only applicable
+      # for regional snapshots.
+  "satisfiesPzi": True or False, # Output only. Reserved for future use.
+  "satisfiesPzs": True or False, # Output only. [Output Only] Reserved for future use.
+  "selfLink": "A String", # Output only. [Output Only] Server-defined URL for the resource.
+  "snapshotEncryptionKey": { # Encrypts the snapshot using acustomer-supplied
+      # encryption key.
+      # 
+      # After you encrypt a snapshot using a customer-supplied key, you must
+      # provide the same key if you use the snapshot later. For example, you must
+      # provide the encryption key when you create a disk from the encrypted
+      # snapshot in a future request.
+      # 
+      # Customer-supplied encryption keys do not protect access to metadata
+      # of the snapshot.
+      # 
+      # If you do not provide an encryption key when creating the snapshot, then
+      # the snapshot will be encrypted using an automatically generated key and you
+      # do not need to provide a key to use the snapshot later.
+    "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
+        # For example:
+        #
+        # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+        # key_region/cryptoKeys/key
+        #
+        # The fully-qualifed key name may be returned for resource GET requests. For
+        # example:
+        #
+        # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+        # key_region/cryptoKeys/key
+        # /cryptoKeyVersions/1
+    "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
+        # key. If absent, the Compute Engine default service account is used.
+        # For example:
+        #
+        # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
+    "rawKey": "A String", # Specifies a 256-bit customer-supplied
+        # encryption key, encoded in RFC
+        # 4648 base64 to either encrypt or decrypt this resource. You can
+        # provide either the rawKey or thersaEncryptedKey.
+        # For example:
+        #
+        # "rawKey":
+        # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
+    "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
+        # customer-supplied encryption key to either encrypt or decrypt this
+        # resource. You can provide either the rawKey or thersaEncryptedKey.
+        # For example:
+        #
+        # "rsaEncryptedKey":
+        # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
+        # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
+        # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
+        #
+        # The key must meet the following requirements before you can provide it to
+        # Compute Engine:
+        #
+        #    1. The key is wrapped using a RSA public key certificate provided by
+        #    Google.
+        #    2. After being wrapped, the key must be encoded in RFC 4648 base64
+        #    encoding.
+        #
+        # Gets the RSA public key certificate provided by Google at:
+        #
+        #
+        # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+    "sha256": "A String", # [Output only] TheRFC
+        # 4648 base64 encoded SHA-256 hash of the customer-supplied
+        # encryption key that protects this resource.
+  },
+  "snapshotGroupId": "A String", # Output only. [Output Only] The unique ID of the snapshot group that this snapshot
+      # belongs to. The usage of snapshot group feature is restricted.
+  "snapshotGroupName": "A String", # Output only. [Output only] The snapshot group that this snapshot belongs to. The usage
+      # of snapshot group feature is restricted.
+  "snapshotType": "A String", # Indicates the type of the snapshot.
+  "sourceDisk": "A String", # The source disk used to create this snapshot.
+  "sourceDiskEncryptionKey": { # The customer-supplied
+      # encryption key of the source disk. Required if the source disk is
+      # protected by a customer-supplied encryption key.
+    "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
+        # For example:
+        #
+        # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+        # key_region/cryptoKeys/key
+        #
+        # The fully-qualifed key name may be returned for resource GET requests. For
+        # example:
+        #
+        # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+        # key_region/cryptoKeys/key
+        # /cryptoKeyVersions/1
+    "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
+        # key. If absent, the Compute Engine default service account is used.
+        # For example:
+        #
+        # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
+    "rawKey": "A String", # Specifies a 256-bit customer-supplied
+        # encryption key, encoded in RFC
+        # 4648 base64 to either encrypt or decrypt this resource. You can
+        # provide either the rawKey or thersaEncryptedKey.
+        # For example:
+        #
+        # "rawKey":
+        # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
+    "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
+        # customer-supplied encryption key to either encrypt or decrypt this
+        # resource. You can provide either the rawKey or thersaEncryptedKey.
+        # For example:
+        #
+        # "rsaEncryptedKey":
+        # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
+        # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
+        # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
+        #
+        # The key must meet the following requirements before you can provide it to
+        # Compute Engine:
+        #
+        #    1. The key is wrapped using a RSA public key certificate provided by
+        #    Google.
+        #    2. After being wrapped, the key must be encoded in RFC 4648 base64
+        #    encoding.
+        #
+        # Gets the RSA public key certificate provided by Google at:
+        #
+        #
+        # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+    "sha256": "A String", # [Output only] TheRFC
+        # 4648 base64 encoded SHA-256 hash of the customer-supplied
+        # encryption key that protects this resource.
+  },
+  "sourceDiskForRecoveryCheckpoint": "A String", # The source disk whose recovery checkpoint will be used to create this
+      # snapshot.
+  "sourceDiskId": "A String", # Output only. [Output Only] The ID value of the disk used to create this snapshot. This
+      # value may be used to determine whether the snapshot was taken from the
+      # current or a previous instance of a given disk name.
+  "sourceInstantSnapshot": "A String", # The source instant snapshot used to create this snapshot. You can provide
+      # this as a partial or full URL to the resource. For example, the following
+      # are valid values:
+      # 
+      # 
+      #      - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instantSnapshots/instantSnapshot
+      #      - projects/project/zones/zone/instantSnapshots/instantSnapshot
+      #    - zones/zone/instantSnapshots/instantSnapshot
+  "sourceInstantSnapshotEncryptionKey": { # Customer provided encryption key when creating Snapshot from Instant
+      # Snapshot.
+    "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
+        # For example:
+        #
+        # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+        # key_region/cryptoKeys/key
+        #
+        # The fully-qualifed key name may be returned for resource GET requests. For
+        # example:
+        #
+        # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+        # key_region/cryptoKeys/key
+        # /cryptoKeyVersions/1
+    "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
+        # key. If absent, the Compute Engine default service account is used.
+        # For example:
+        #
+        # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
+    "rawKey": "A String", # Specifies a 256-bit customer-supplied
+        # encryption key, encoded in RFC
+        # 4648 base64 to either encrypt or decrypt this resource. You can
+        # provide either the rawKey or thersaEncryptedKey.
+        # For example:
+        #
+        # "rawKey":
+        # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
+    "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
+        # customer-supplied encryption key to either encrypt or decrypt this
+        # resource. You can provide either the rawKey or thersaEncryptedKey.
+        # For example:
+        #
+        # "rsaEncryptedKey":
+        # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
+        # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
+        # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
+        #
+        # The key must meet the following requirements before you can provide it to
+        # Compute Engine:
+        #
+        #    1. The key is wrapped using a RSA public key certificate provided by
+        #    Google.
+        #    2. After being wrapped, the key must be encoded in RFC 4648 base64
+        #    encoding.
+        #
+        # Gets the RSA public key certificate provided by Google at:
+        #
+        #
+        # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+    "sha256": "A String", # [Output only] TheRFC
+        # 4648 base64 encoded SHA-256 hash of the customer-supplied
+        # encryption key that protects this resource.
+  },
+  "sourceInstantSnapshotId": "A String", # Output only. [Output Only] The unique ID of the instant snapshot used to create this
+      # snapshot. This value identifies the exact instant snapshot that was used to
+      # create this snapshot. For example, if you created the snapshot from an
+      # instant snapshot that was later deleted and recreated under the same name,
+      # the source instant snapshot ID would identify the exact instant snapshot
+      # that was used.
+  "sourceSnapshotSchedulePolicy": "A String", # Output only. [Output Only] URL of the resource policy which created this
+      # scheduled snapshot.
+  "sourceSnapshotSchedulePolicyId": "A String", # Output only. [Output Only] ID of the resource policy which created this
+      # scheduled snapshot.
+  "status": "A String", # Output only. [Output Only] The status of the snapshot. This can beCREATING, DELETING, FAILED,READY, or UPLOADING.
+  "storageBytes": "A String", # Output only. [Output Only] A size of the storage used by the snapshot. As snapshots
+      # share storage, this number is expected to change with snapshot
+      # creation/deletion.
+  "storageBytesStatus": "A String", # Output only. [Output Only] An indicator whether storageBytes is in a
+      # stable state or it is being adjusted as a result of shared storage
+      # reallocation. This status can either be UPDATING, meaning
+      # the size of the snapshot is being updated, or UP_TO_DATE,
+      # meaning the size of the snapshot is up-to-date.
+  "storageLocations": [ # Cloud Storage bucket storage location of the snapshot (regional or
+      # multi-regional).
+    "A String",
+  ],
+}
+
+  requestId: string, An optional request ID to identify requests. Specify a unique request ID so
+that if you must retry your request, the server will know to ignore the
+request if it has already been completed.
+
+For example, consider a situation where you make an initial request and
+the request times out. If you make the request again with the same
+request ID, the server can check if original operation with the same
+request ID was received, and if so, will ignore the second request. This
+prevents clients from accidentally creating duplicate commitments.
+
+The request ID must be
+a valid UUID with the exception that zero UUID is not supported
+(00000000-0000-0000-0000-000000000000).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an Operation resource.
+    #
+    # Google Compute Engine has three Operation resources:
+    #
+    # * [Global](/compute/docs/reference/rest/v1/globalOperations)
+    # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
+    # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
+    #
+    # You can use an operation resource to manage asynchronous API requests.
+    # For more information, readHandling
+    # API responses.
+    #
+    # Operations can be global, regional or zonal.
+    #
+    #    - For global operations, use the `globalOperations`
+    #    resource.
+    #    - For regional operations, use the
+    #    `regionOperations` resource.
+    #    - For zonal operations, use
+    #    the `zoneOperations` resource.
+    #
+    #
+    #
+    # For more information, read
+    # Global, Regional, and Zonal Resources.
+    #
+    # Note that completed Operation resources have a limited
+    # retention period.
+  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
+      # Not present otherwise.
+  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+  "description": "A String", # [Output Only] A textual description of the operation, which is
+      # set when the operation is created.
+  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
+      # text format.
+  "error": { # [Output Only] If errors are generated during processing of the operation,
+      # this field will be populated.
+    "errors": [ # [Output Only] The array of errors encountered while processing this
+        # operation.
+      {
+        "code": "A String", # [Output Only] The error type identifier for this error.
+        "errorDetails": [ # [Output Only] An optional list of messages that contain the error
+            # details. There is a set of defined message types to use for providing
+            # details.The syntax depends on the error code. For example,
+            # QuotaExceededInfo will have details when the error code is
+            # QUOTA_EXCEEDED.
+          {
+            "errorInfo": { # Describes the cause of the error with structured details.
+                #
+                # Example of an error when contacting the "pubsub.googleapis.com" API when it
+                # is not enabled:
+                #
+                #     { "reason": "API_DISABLED"
+                #       "domain": "googleapis.com"
+                #       "metadata": {
+                #         "resource": "projects/123",
+                #         "service": "pubsub.googleapis.com"
+                #       }
+                #     }
+                #
+                # This response indicates that the pubsub.googleapis.com API is not enabled.
+                #
+                # Example of an error that is returned when attempting to create a Spanner
+                # instance in a region that is out of stock:
+                #
+                #     { "reason": "STOCKOUT"
+                #       "domain": "spanner.googleapis.com",
+                #       "metadata": {
+                #         "availableRegions": "us-central1,us-east2"
+                #       }
+                #     }
+              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+                  # is typically the registered service name of the tool or product that
+                  # generates the error. Example: "pubsub.googleapis.com". If the error is
+                  # generated by some common infrastructure, the error domain must be a
+                  # globally unique value that identifies the infrastructure. For Google API
+                  # infrastructure, the error domain is "googleapis.com".
+              "metadatas": { # Additional structured details about this error.
+                  #
+                  # Keys must match a regular expression of `a-z+` but should
+                  # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+                  # length. When identifying the current value of an exceeded limit, the units
+                  # should be contained in the key, not the value.  For example, rather than
+                  # `{"instanceLimit": "100/request"}`, should be returned as,
+                  # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+                  # instances that can be created in a single (batch) request.
+                "a_key": "A String",
+              },
+              "reason": "A String", # The reason of the error. This is a constant value that identifies the
+                  # proximate cause of the error. Error reasons are unique within a particular
+                  # domain of errors. This should be at most 63 characters and match a
+                  # regular expression of `A-Z+[A-Z0-9]`, which represents
+                  # UPPER_SNAKE_CASE.
+            },
+            "help": { # Provides links to documentation or for performing an out of band action.
+                #
+                # For example, if a quota check failed with an error indicating the calling
+                # project hasn't enabled the accessed service, this can contain a URL pointing
+                # directly to the right place in the developer console to flip the bit.
+              "links": [ # URL(s) pointing to additional information on handling the current error.
+                { # Describes a URL link.
+                  "description": "A String", # Describes what the link offers.
+                  "url": "A String", # The URL of the link.
+                },
+              ],
+            },
+            "localizedMessage": { # Provides a localized error message that is safe to return to the user
+                # which can be attached to an RPC error.
+              "locale": "A String", # The locale used following the specification defined at
+                  # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+                  # Examples are: "en-US", "fr-CH", "es-MX"
+              "message": "A String", # The localized error message in the above locale.
+            },
+            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+              "dimensions": { # The map holding related quota dimensions.
+                "a_key": "A String",
+              },
+              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+                  #  type or metric.
+              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+                  # or metric.
+              "limitName": "A String", # The name of the quota limit.
+              "metricName": "A String", # The Compute Engine quota metric name.
+              "rolloutStatus": "A String", # Rollout status of the future quota limit.
+            },
+          },
+        ],
+        "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+            # This property is optional.
+        "message": "A String", # [Output Only] An optional, human-readable error message.
+      },
+    ],
+  },
+  "getVersionOperationMetadata": {
+    "inlineSbomInfo": {
+      "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+          # name and the value is the version.
+        "a_key": "A String",
+      },
+      "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+          # component name and the value is the version.
+        "a_key": "A String",
+      },
+    },
+  },
+  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
+      # message that was returned, such as `NOT FOUND`.
+  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
+      # status code that was returned. For example, a `404` means the
+      # resource was not found.
+  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
+      # defined by the server.
+  "insertTime": "A String", # [Output Only] The time that this operation was requested.
+      # This value is inRFC3339
+      # text format.
+  "instancesBulkInsertOperationMetadata": {
+    "perLocationStatus": { # Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
+            # error.
+        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
+            # if the flow is rolling forward or rolling back.
+        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+      },
+    },
+  },
+  "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
+      # Operation resources.
+  "name": "A String", # [Output Only] Name of the operation.
+  "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
+      # group of operations results from a `bulkInsert` API request.
+  "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
+      # `update`, or `delete`, and so on.
+  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
+      # There is no requirement that this be linear or support any granularity of
+      # operations. This should not be used to guess when the operation will be
+      # complete. This number should monotonically increase as the operation
+      # progresses.
+  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
+      # applicable when performing regional operations.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
+      # this field will contain information on all underlying zonal actions and
+      # their state.
+    "clientOperationId": "A String", # [Output Only] The client operation id.
+    "perLocationOperations": { # [Output Only] Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
+            # populated.
+            # different programming environments, including REST APIs and RPC APIs. It is
+            # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+            # three pieces of data: error code, error message, and error details.
+            #
+            # You can find out more about this error model and how to work with it in the
+            # [API Design Guide](https://cloud.google.com/apis/design/errors).
+          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+          "details": [ # A list of messages that carry the error details.  There is a common set of
+              # message types for APIs to use.
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+          "message": "A String", # A developer-facing error message, which should be in English. Any
+              # user-facing error message should be localized and sent in the
+              # google.rpc.Status.details field, or localized by the client.
+        },
+        "state": "A String", # [Output Only] Status of the action, which can be one of the following:
+            # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+      },
+    },
+  },
+  "startTime": "A String", # [Output Only] The time that this operation was started by the server.
+      # This value is inRFC3339
+      # text format.
+  "status": "A String", # [Output Only] The status of the operation, which can be one of the
+      # following:
+      # `PENDING`, `RUNNING`, or `DONE`.
+  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
+      # operation.
+  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
+      # of the target resource.
+  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
+      # operations related to creating a snapshot, this points to the disk
+      # that the snapshot was created from.
+  "user": "A String", # [Output Only] User who requested the operation, for example:
+      # `user@example.com` or
+      # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+  "warnings": [ # [Output Only] If warning messages are generated during processing of the
+      # operation, this field will be populated.
+    {
+      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+          # Engine returns NO_RESULTS_ON_PAGE if there
+          # are no results in the response.
+      "data": [ # [Output Only] Metadata about this warning in key:
+          # value format. For example:
+          #
+          # "data": [
+          #   {
+          #    "key": "scope",
+          #    "value": "zones/us-east1-d"
+          #   }
+        {
+          "key": "A String", # [Output Only] A key that provides more detail on the warning being
+              # returned. For example, for warnings where there are no results in a list
+              # request for a particular zone, this key might be scope and
+              # the key value might be the zone name. Other examples might be a key
+              # indicating a deprecated resource and a suggested replacement, or a
+              # warning about invalid network settings (for example, if an instance
+              # attempts to perform IP forwarding but is not enabled for IP forwarding).
+          "value": "A String", # [Output Only] A warning data value corresponding to the key.
+        },
+      ],
+      "message": "A String", # [Output Only] A human-readable description of the warning code.
+    },
+  ],
+  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
+      # applicable when performing per-zone operations.
+}
+
+ +
+ list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) +
Retrieves the list of Snapshot resources contained within
+the specified region.
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, Name of the region for this request. (required)
+  filter: string, A filter expression that filters resources listed in the response. Most
+Compute resources support two types of filter expressions:
+expressions that support regular expressions and expressions that follow
+API improvement proposal AIP-160.
+These two types of filter expressions cannot be mixed in one request.
+
+If you want to use AIP-160, your expression must specify the field name, an
+operator, and the value that you want to use for filtering. The value
+must be a string, a number, or a boolean. The operator
+must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.
+
+For example, if you are filtering Compute Engine instances, you can
+exclude instances named `example-instance` by specifying
+`name != example-instance`.
+
+The `:*` comparison can be used to test whether a key has been defined.
+For example, to find all objects with `owner` label use:
+```
+labels.owner:*
+```
+
+You can also filter nested fields. For example, you could specify
+`scheduling.automaticRestart = false` to include instances only
+if they are not scheduled for automatic restarts. You can use filtering
+on nested fields to filter based onresource labels.
+
+To filter on multiple expressions, provide each separate expression within
+parentheses. For example:
+```
+(scheduling.automaticRestart = true)
+(cpuPlatform = "Intel Skylake")
+```
+By default, each expression is an `AND` expression. However, you
+can include `AND` and `OR` expressions explicitly.
+For example:
+```
+(cpuPlatform = "Intel Skylake") OR
+(cpuPlatform = "Intel Broadwell") AND
+(scheduling.automaticRestart = true)
+```
+
+If you want to use a regular expression, use the `eq` (equal) or `ne`
+(not equal) operator against a single un-parenthesized expression with or
+without quotes or against multiple parenthesized expressions. Examples:
+
+`fieldname eq unquoted literal`
+`fieldname eq 'single quoted literal'`
+`fieldname eq "double quoted literal"`
+`(fieldname1 eq literal) (fieldname2 ne "literal")`
+
+The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
+The literal value must match the entire field.
+
+For example, to filter for instances that do not end with name "instance",
+you would use `name ne .*instance`.
+
+You cannot combine constraints on multiple fields using regular
+expressions.
+  maxResults: integer, The maximum number of results per page that should be returned.
+If the number of available results is larger than `maxResults`,
+Compute Engine returns a `nextPageToken` that can be used to get
+the next page of results in subsequent list requests. Acceptable values are
+`0` to `500`, inclusive. (Default: `500`)
+  orderBy: string, Sorts list results by a certain order. By default, results
+are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation
+timestamp using `orderBy="creationTimestamp desc"`. This sorts
+results based on the `creationTimestamp` field in
+reverse chronological order (newest result first). Use this to sort
+resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by `name` or
+`creationTimestamp desc` is supported.
+  pageToken: string, Specifies a page token to use. Set `pageToken` to the
+`nextPageToken` returned by a previous list request to get
+the next page of results.
+  returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
+of failure. The default value is false.
+
+For example, when partial success behavior is enabled, aggregatedList for a
+single zone scope either returns all resources in the zone or no resources,
+with an error code.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Contains a list of Snapshot resources.
+  "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+  "items": [ # A list of Snapshot resources.
+    { # Represents a Persistent Disk Snapshot resource.
+        #
+        # You can use snapshots to back up data on a regular interval. For more
+        # information, read  Creating
+        # persistent disk snapshots.
+      "architecture": "A String", # Output only. [Output Only] The architecture of the snapshot. Valid values are
+          # ARM64 or X86_64.
+      "autoCreated": True or False, # Output only. [Output Only] Set to true if snapshots are automatically created by
+          # applying resource policy on the target disk.
+      "chainName": "A String", # Creates the new snapshot in the snapshot chain labeled with the
+          # specified name. The chain name must be 1-63 characters long and comply
+          # with RFC1035. This is an uncommon option only for advanced service
+          # owners who needs to create separate snapshot chains, for example,
+          # for chargeback tracking. When you describe your snapshot resource, this
+          # field is visible only if it has a non-empty value.
+      "creationSizeBytes": "A String", # Output only. [Output Only] Size in bytes of the snapshot at creation time.
+      "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339
+          # text format.
+      "description": "A String", # An optional description of this resource. Provide this property when you
+          # create the resource.
+      "diskSizeGb": "A String", # Output only. [Output Only] Size of the source disk, specified in GB.
+      "downloadBytes": "A String", # Output only. [Output Only] Number of bytes downloaded to restore a snapshot to a disk.
+      "enableConfidentialCompute": True or False, # Output only. Whether this snapshot is created from a confidential compute mode disk.
+          # [Output Only]: This field is not set by user, but from source disk.
+      "guestFlush": True or False, # [Input Only] Whether to attempt an application consistent snapshot by
+          # informing the OS to prepare for the snapshot process.
+      "guestOsFeatures": [ # Output only. [Output Only] A list of features to enable on the guest operating system.
+          # Applicable only for bootable images. Read
+          # Enabling guest operating system features to see a list of available
+          # options.
+        { # Guest OS features.
+          "type": "A String", # The ID of a supported feature. To add multiple values, use commas to
+              # separate values. Set to one or more of the following values:
+              #
+              #    - VIRTIO_SCSI_MULTIQUEUE
+              #    - WINDOWS
+              #    - MULTI_IP_SUBNET
+              #    - UEFI_COMPATIBLE
+              #    - GVNIC
+              #    - SEV_CAPABLE
+              #    - SUSPEND_RESUME_COMPATIBLE
+              #    - SEV_LIVE_MIGRATABLE_V2
+              #    - SEV_SNP_CAPABLE
+              #    - TDX_CAPABLE
+              #    - IDPF
+              #    - SNP_SVSM_CAPABLE
+              #    - CCA_CAPABLE
+              #
+              #
+              # For more information, see
+              # Enabling guest operating system features.
+        },
+      ],
+      "id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is
+          # defined by the server.
+      "kind": "compute#snapshot", # Output only. [Output Only] Type of the resource. Always compute#snapshot
+          # for Snapshot resources.
+      "labelFingerprint": "A String", # A fingerprint for the labels being applied to this snapshot, which is
+          # essentially a hash of the labels set used for optimistic locking. The
+          # fingerprint is initially generated by Compute Engine and changes after
+          # every request to modify or update labels. You must always provide an
+          # up-to-date fingerprint hash in order to update or change labels,
+          # otherwise the request will fail with error412 conditionNotMet.
+          #
+          # To see the latest fingerprint, make a get() request to
+          # retrieve a snapshot.
+      "labels": { # Labels to apply to this snapshot. These can be later modified by
+          # the setLabels method.
+          # Label values may be empty.
+        "a_key": "A String",
+      },
+      "licenseCodes": [ # Output only. [Output Only] Integer license codes indicating which licenses are attached
+          # to this snapshot.
+        "A String",
+      ],
+      "licenses": [ # Output only. [Output Only] A list of public visible licenses that apply to this
+          # snapshot. This can be because the original image had licenses attached
+          # (such as a Windows image).
+        "A String",
+      ],
+      "locationHint": "A String", # An opaque location hint used to place the snapshot close to other
+          # resources.
+          # This field is for use by internal tools that use the public API.
+      "name": "A String", # Name of the resource; provided by the client when the resource is created.
+          # The name must be 1-63 characters long, and comply withRFC1035.
+          # Specifically, the name must be 1-63 characters long and match the regular
+          # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
+          # character must be a lowercase letter, and all following characters must be
+          # a dash, lowercase letter, or digit, except the last character, which cannot
+          # be a dash.
+      "params": { # Additional snapshot params. # Input only. [Input Only] Additional params passed with the request, but not persisted
+          # as part of resource payload.
+        "resourceManagerTags": { # Input only. Resource manager tags to be bound to the snapshot. Tag keys and values have
+            # the same definition as resource
+            # manager tags. Keys and values can be either in numeric format,
+            # such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
+            # format such as `{org_id|project_id}/{tag_key_short_name}` and
+            # `{tag_value_short_name}`. The field is ignored (both PUT &
+            # PATCH) when empty.
+          "a_key": "A String",
+        },
+      },
+      "region": "A String", # Output only. [Output Only] URL of the region where the snapshot resides. Only applicable
+          # for regional snapshots.
+      "satisfiesPzi": True or False, # Output only. Reserved for future use.
+      "satisfiesPzs": True or False, # Output only. [Output Only] Reserved for future use.
+      "selfLink": "A String", # Output only. [Output Only] Server-defined URL for the resource.
+      "snapshotEncryptionKey": { # Encrypts the snapshot using acustomer-supplied
+          # encryption key.
+          #
+          # After you encrypt a snapshot using a customer-supplied key, you must
+          # provide the same key if you use the snapshot later. For example, you must
+          # provide the encryption key when you create a disk from the encrypted
+          # snapshot in a future request.
+          #
+          # Customer-supplied encryption keys do not protect access to metadata
+          # of the snapshot.
+          #
+          # If you do not provide an encryption key when creating the snapshot, then
+          # the snapshot will be encrypted using an automatically generated key and you
+          # do not need to provide a key to use the snapshot later.
+        "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
+            # For example:
+            #
+            # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+            # key_region/cryptoKeys/key
+            #
+            # The fully-qualifed key name may be returned for resource GET requests. For
+            # example:
+            #
+            # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+            # key_region/cryptoKeys/key
+            # /cryptoKeyVersions/1
+        "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
+            # key. If absent, the Compute Engine default service account is used.
+            # For example:
+            #
+            # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
+        "rawKey": "A String", # Specifies a 256-bit customer-supplied
+            # encryption key, encoded in RFC
+            # 4648 base64 to either encrypt or decrypt this resource. You can
+            # provide either the rawKey or thersaEncryptedKey.
+            # For example:
+            #
+            # "rawKey":
+            # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
+        "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
+            # customer-supplied encryption key to either encrypt or decrypt this
+            # resource. You can provide either the rawKey or thersaEncryptedKey.
+            # For example:
+            #
+            # "rsaEncryptedKey":
+            # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
+            # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
+            # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
+            #
+            # The key must meet the following requirements before you can provide it to
+            # Compute Engine:
+            #
+            #    1. The key is wrapped using a RSA public key certificate provided by
+            #    Google.
+            #    2. After being wrapped, the key must be encoded in RFC 4648 base64
+            #    encoding.
+            #
+            # Gets the RSA public key certificate provided by Google at:
+            #
+            #
+            # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+        "sha256": "A String", # [Output only] TheRFC
+            # 4648 base64 encoded SHA-256 hash of the customer-supplied
+            # encryption key that protects this resource.
+      },
+      "snapshotGroupId": "A String", # Output only. [Output Only] The unique ID of the snapshot group that this snapshot
+          # belongs to. The usage of snapshot group feature is restricted.
+      "snapshotGroupName": "A String", # Output only. [Output only] The snapshot group that this snapshot belongs to. The usage
+          # of snapshot group feature is restricted.
+      "snapshotType": "A String", # Indicates the type of the snapshot.
+      "sourceDisk": "A String", # The source disk used to create this snapshot.
+      "sourceDiskEncryptionKey": { # The customer-supplied
+          # encryption key of the source disk. Required if the source disk is
+          # protected by a customer-supplied encryption key.
+        "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
+            # For example:
+            #
+            # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+            # key_region/cryptoKeys/key
+            #
+            # The fully-qualifed key name may be returned for resource GET requests. For
+            # example:
+            #
+            # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+            # key_region/cryptoKeys/key
+            # /cryptoKeyVersions/1
+        "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
+            # key. If absent, the Compute Engine default service account is used.
+            # For example:
+            #
+            # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
+        "rawKey": "A String", # Specifies a 256-bit customer-supplied
+            # encryption key, encoded in RFC
+            # 4648 base64 to either encrypt or decrypt this resource. You can
+            # provide either the rawKey or thersaEncryptedKey.
+            # For example:
+            #
+            # "rawKey":
+            # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
+        "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
+            # customer-supplied encryption key to either encrypt or decrypt this
+            # resource. You can provide either the rawKey or thersaEncryptedKey.
+            # For example:
+            #
+            # "rsaEncryptedKey":
+            # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
+            # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
+            # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
+            #
+            # The key must meet the following requirements before you can provide it to
+            # Compute Engine:
+            #
+            #    1. The key is wrapped using a RSA public key certificate provided by
+            #    Google.
+            #    2. After being wrapped, the key must be encoded in RFC 4648 base64
+            #    encoding.
+            #
+            # Gets the RSA public key certificate provided by Google at:
+            #
+            #
+            # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+        "sha256": "A String", # [Output only] TheRFC
+            # 4648 base64 encoded SHA-256 hash of the customer-supplied
+            # encryption key that protects this resource.
+      },
+      "sourceDiskForRecoveryCheckpoint": "A String", # The source disk whose recovery checkpoint will be used to create this
+          # snapshot.
+      "sourceDiskId": "A String", # Output only. [Output Only] The ID value of the disk used to create this snapshot. This
+          # value may be used to determine whether the snapshot was taken from the
+          # current or a previous instance of a given disk name.
+      "sourceInstantSnapshot": "A String", # The source instant snapshot used to create this snapshot. You can provide
+          # this as a partial or full URL to the resource. For example, the following
+          # are valid values:
+          #
+          #
+          #      - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instantSnapshots/instantSnapshot
+          #      - projects/project/zones/zone/instantSnapshots/instantSnapshot
+          #    - zones/zone/instantSnapshots/instantSnapshot
+      "sourceInstantSnapshotEncryptionKey": { # Customer provided encryption key when creating Snapshot from Instant
+          # Snapshot.
+        "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
+            # For example:
+            #
+            # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+            # key_region/cryptoKeys/key
+            #
+            # The fully-qualifed key name may be returned for resource GET requests. For
+            # example:
+            #
+            # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+            # key_region/cryptoKeys/key
+            # /cryptoKeyVersions/1
+        "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
+            # key. If absent, the Compute Engine default service account is used.
+            # For example:
+            #
+            # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
+        "rawKey": "A String", # Specifies a 256-bit customer-supplied
+            # encryption key, encoded in RFC
+            # 4648 base64 to either encrypt or decrypt this resource. You can
+            # provide either the rawKey or thersaEncryptedKey.
+            # For example:
+            #
+            # "rawKey":
+            # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
+        "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
+            # customer-supplied encryption key to either encrypt or decrypt this
+            # resource. You can provide either the rawKey or thersaEncryptedKey.
+            # For example:
+            #
+            # "rsaEncryptedKey":
+            # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
+            # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
+            # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
+            #
+            # The key must meet the following requirements before you can provide it to
+            # Compute Engine:
+            #
+            #    1. The key is wrapped using a RSA public key certificate provided by
+            #    Google.
+            #    2. After being wrapped, the key must be encoded in RFC 4648 base64
+            #    encoding.
+            #
+            # Gets the RSA public key certificate provided by Google at:
+            #
+            #
+            # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+        "sha256": "A String", # [Output only] TheRFC
+            # 4648 base64 encoded SHA-256 hash of the customer-supplied
+            # encryption key that protects this resource.
+      },
+      "sourceInstantSnapshotId": "A String", # Output only. [Output Only] The unique ID of the instant snapshot used to create this
+          # snapshot. This value identifies the exact instant snapshot that was used to
+          # create this snapshot. For example, if you created the snapshot from an
+          # instant snapshot that was later deleted and recreated under the same name,
+          # the source instant snapshot ID would identify the exact instant snapshot
+          # that was used.
+      "sourceSnapshotSchedulePolicy": "A String", # Output only. [Output Only] URL of the resource policy which created this
+          # scheduled snapshot.
+      "sourceSnapshotSchedulePolicyId": "A String", # Output only. [Output Only] ID of the resource policy which created this
+          # scheduled snapshot.
+      "status": "A String", # Output only. [Output Only] The status of the snapshot. This can beCREATING, DELETING, FAILED,READY, or UPLOADING.
+      "storageBytes": "A String", # Output only. [Output Only] A size of the storage used by the snapshot. As snapshots
+          # share storage, this number is expected to change with snapshot
+          # creation/deletion.
+      "storageBytesStatus": "A String", # Output only. [Output Only] An indicator whether storageBytes is in a
+          # stable state or it is being adjusted as a result of shared storage
+          # reallocation. This status can either be UPDATING, meaning
+          # the size of the snapshot is being updated, or UP_TO_DATE,
+          # meaning the size of the snapshot is up-to-date.
+      "storageLocations": [ # Cloud Storage bucket storage location of the snapshot (regional or
+          # multi-regional).
+        "A String",
+      ],
+    },
+  ],
+  "kind": "compute#snapshotList", # Output only. Type of resource.
+  "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for
+      # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
+      # the query parameter pageToken in the next list request.
+      # Subsequent list requests will have their own nextPageToken to
+      # continue paging through the results.
+  "selfLink": "A String", # Output only. [Output Only] Server-defined URL for this resource.
+  "warning": { # [Output Only] Informational warning message.
+    "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+        # Engine returns NO_RESULTS_ON_PAGE if there
+        # are no results in the response.
+    "data": [ # [Output Only] Metadata about this warning in key:
+        # value format. For example:
+        #
+        # "data": [
+        #   {
+        #    "key": "scope",
+        #    "value": "zones/us-east1-d"
+        #   }
+      {
+        "key": "A String", # [Output Only] A key that provides more detail on the warning being
+            # returned. For example, for warnings where there are no results in a list
+            # request for a particular zone, this key might be scope and
+            # the key value might be the zone name. Other examples might be a key
+            # indicating a deprecated resource and a suggested replacement, or a
+            # warning about invalid network settings (for example, if an instance
+            # attempts to perform IP forwarding but is not enabled for IP forwarding).
+        "value": "A String", # [Output Only] A warning data value corresponding to the key.
+      },
+    ],
+    "message": "A String", # [Output Only] A human-readable description of the warning code.
+  },
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ setIamPolicy(project, region, resource, body=None, x__xgafv=None) +
Sets the access control policy on the specified resource.
+Replaces any existing policy.
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, The name of the region for this request. (required)
+  resource: string, Name or id of the resource for this request. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{
+  "bindings": [ # Flatten Policy to create a backwacd compatible wire-format.
+      # Deprecated. Use 'policy' to specify bindings.
+    { # Associates `members`, or principals, with a `role`.
+      "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
+          #
+          # If the condition evaluates to `true`, then this binding applies to the
+          # current request.
+          #
+          # If the condition evaluates to `false`, then this binding does not apply to
+          # the current request. However, a different role binding might grant the same
+          # role to one or more of the principals in this binding.
+          #
+          # To learn which resources support conditions in their IAM policies, see the
+          # [IAM
+          # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+          # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
+          # are documented at https://github.com/google/cel-spec.
+          #
+          # Example (Comparison):
+          #
+          #     title: "Summary size limit"
+          #     description: "Determines if a summary is less than 100 chars"
+          #     expression: "document.summary.size() < 100"
+          #
+          # Example (Equality):
+          #
+          #     title: "Requestor is owner"
+          #     description: "Determines if requestor is the document owner"
+          #     expression: "document.owner == request.auth.claims.email"
+          #
+          # Example (Logic):
+          #
+          #     title: "Public documents"
+          #     description: "Determine whether the document should be publicly visible"
+          #     expression: "document.type != 'private' && document.type != 'internal'"
+          #
+          # Example (Data Manipulation):
+          #
+          #     title: "Notification string"
+          #     description: "Create a notification string with a timestamp."
+          #     expression: "'New message received at ' + string(document.create_time)"
+          #
+          # The exact variables and functions that may be referenced within an expression
+          # are determined by the service that evaluates it. See the service
+          # documentation for additional information.
+        "description": "A String", # Optional. Description of the expression. This is a longer text which
+            # describes the expression, e.g. when hovered over it in a UI.
+        "expression": "A String", # Textual representation of an expression in Common Expression Language
+            # syntax.
+        "location": "A String", # Optional. String indicating the location of the expression for error
+            # reporting, e.g. a file name and a position in the file.
+        "title": "A String", # Optional. Title for the expression, i.e. a short string describing
+            # its purpose. This can be used e.g. in UIs which allow to enter the
+            # expression.
+      },
+      "members": [ # Specifies the principals requesting access for a Google Cloud resource.
+          # `members` can have the following values:
+          #
+          # * `allUsers`: A special identifier that represents anyone who is
+          #    on the internet; with or without a Google account.
+          #
+          # * `allAuthenticatedUsers`: A special identifier that represents anyone
+          #    who is authenticated with a Google account or a service account.
+          #    Does not include identities that come from external identity providers
+          #    (IdPs) through identity federation.
+          #
+          # * `user:{emailid}`: An email address that represents a specific Google
+          #    account. For example, `alice@example.com` .
+          #
+          #
+          # * `serviceAccount:{emailid}`: An email address that represents a Google
+          #    service account. For example,
+          #    `my-other-app@appspot.gserviceaccount.com`.
+          #
+          # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
+          #    identifier for a
+          #    [Kubernetes service
+          #    account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
+          #    For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
+          #
+          # * `group:{emailid}`: An email address that represents a Google group.
+          #    For example, `admins@example.com`.
+          #
+          #
+          # * `domain:{domain}`: The G Suite domain (primary) that represents all the
+          #    users of that domain. For example, `google.com` or `example.com`.
+          #
+          #
+          #
+          #
+          # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
+          #   A single identity in a workforce identity pool.
+          #
+          # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
+          #   All workforce identities in a group.
+          #
+          # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
+          #   All workforce identities with a specific attribute value.
+          #
+          # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
+          #   All identities in a workforce identity pool.
+          #
+          # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
+          #   A single identity in a workload identity pool.
+          #
+          # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
+          #   A workload identity pool group.
+          #
+          # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
+          #   All identities in a workload identity pool with a certain attribute.
+          #
+          # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
+          #   All identities in a workload identity pool.
+          #
+          # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
+          #    identifier) representing a user that has been recently deleted. For
+          #    example, `alice@example.com?uid=123456789012345678901`. If the user is
+          #    recovered, this value reverts to `user:{emailid}` and the recovered user
+          #    retains the role in the binding.
+          #
+          # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
+          #    unique identifier) representing a service account that has been recently
+          #    deleted. For example,
+          #    `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
+          #    If the service account is undeleted, this value reverts to
+          #    `serviceAccount:{emailid}` and the undeleted service account retains the
+          #    role in the binding.
+          #
+          # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
+          #    identifier) representing a Google group that has been recently
+          #    deleted. For example, `admins@example.com?uid=123456789012345678901`. If
+          #    the group is recovered, this value reverts to `group:{emailid}` and the
+          #    recovered group retains the role in the binding.
+          #
+          # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
+          #   Deleted single identity in a workforce identity pool. For example,
+          #   `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+        "A String",
+      ],
+      "role": "A String", # Role that is assigned to the list of `members`, or principals.
+          # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+          #
+          # For an overview of the IAM roles and permissions, see the
+          # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
+          # a list of the available pre-defined roles, see
+          # [here](https://cloud.google.com/iam/docs/understanding-roles).
+    },
+  ],
+  "etag": "A String", # Flatten Policy to create a backward compatible wire-format.
+      # Deprecated. Use 'policy' to specify the etag.
+  "policy": { # An Identity and Access Management (IAM) policy, which specifies access # REQUIRED: The complete policy to be applied to the 'resource'. The size of
+      # the policy is limited to a few 10s of KB. An empty policy is in general a
+      # valid policy but certain services (like Projects) might reject them.
+      # controls for Google Cloud resources.
+      #
+      #
+      # A `Policy` is a collection of `bindings`. A `binding` binds one or more
+      # `members`, or principals, to a single `role`. Principals can be user
+      # accounts, service accounts, Google groups, and domains (such as G Suite). A
+      # `role` is a named list of permissions; each `role` can be an IAM predefined
+      # role or a user-created custom role.
+      #
+      # For some types of Google Cloud resources, a `binding` can also specify a
+      # `condition`, which is a logical expression that allows access to a resource
+      # only if the expression evaluates to `true`. A condition can add constraints
+      # based on attributes of the request, the resource, or both. To learn which
+      # resources support conditions in their IAM policies, see the
+      # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+      #
+      # **JSON example:**
+      #
+      # ```
+      #     {
+      #       "bindings": [
+      #         {
+      #           "role": "roles/resourcemanager.organizationAdmin",
+      #           "members": [
+      #             "user:mike@example.com",
+      #             "group:admins@example.com",
+      #             "domain:google.com",
+      #             "serviceAccount:my-project-id@appspot.gserviceaccount.com"
+      #           ]
+      #         },
+      #         {
+      #           "role": "roles/resourcemanager.organizationViewer",
+      #           "members": [
+      #             "user:eve@example.com"
+      #           ],
+      #           "condition": {
+      #             "title": "expirable access",
+      #             "description": "Does not grant access after Sep 2020",
+      #             "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
+      #           }
+      #         }
+      #       ],
+      #       "etag": "BwWWja0YfJA=",
+      #       "version": 3
+      #     }
+      # ```
+      #
+      # **YAML example:**
+      #
+      # ```
+      #     bindings:
+      #     - members:
+      #       - user:mike@example.com
+      #       - group:admins@example.com
+      #       - domain:google.com
+      #       - serviceAccount:my-project-id@appspot.gserviceaccount.com
+      #       role: roles/resourcemanager.organizationAdmin
+      #     - members:
+      #       - user:eve@example.com
+      #       role: roles/resourcemanager.organizationViewer
+      #       condition:
+      #         title: expirable access
+      #         description: Does not grant access after Sep 2020
+      #         expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
+      #     etag: BwWWja0YfJA=
+      #     version: 3
+      # ```
+      #
+      # For a description of IAM and its features, see the
+      # [IAM documentation](https://cloud.google.com/iam/docs/).
+    "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+      { # Specifies the audit configuration for a service.
+          # The configuration determines which permission types are logged, and what
+          # identities, if any, are exempted from logging.
+          # An AuditConfig must have one or more AuditLogConfigs.
+          #
+          # If there are AuditConfigs for both `allServices` and a specific service,
+          # the union of the two AuditConfigs is used for that service: the log_types
+          # specified in each AuditConfig are enabled, and the exempted_members in each
+          # AuditLogConfig are exempted.
+          #
+          # Example Policy with multiple AuditConfigs:
+          #
+          #     {
+          #       "audit_configs": [
+          #         {
+          #           "service": "allServices",
+          #           "audit_log_configs": [
+          #             {
+          #               "log_type": "DATA_READ",
+          #               "exempted_members": [
+          #                 "user:jose@example.com"
+          #               ]
+          #             },
+          #             {
+          #               "log_type": "DATA_WRITE"
+          #             },
+          #             {
+          #               "log_type": "ADMIN_READ"
+          #             }
+          #           ]
+          #         },
+          #         {
+          #           "service": "sampleservice.googleapis.com",
+          #           "audit_log_configs": [
+          #             {
+          #               "log_type": "DATA_READ"
+          #             },
+          #             {
+          #               "log_type": "DATA_WRITE",
+          #               "exempted_members": [
+          #                 "user:aliya@example.com"
+          #               ]
+          #             }
+          #           ]
+          #         }
+          #       ]
+          #     }
+          #
+          # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
+          # logging. It also exempts `jose@example.com` from DATA_READ logging, and
+          # `aliya@example.com` from DATA_WRITE logging.
+        "auditLogConfigs": [ # The configuration for logging of each type of permission.
+          { # Provides the configuration for logging a type of permissions.
+              # Example:
+              #
+              #     {
+              #       "audit_log_configs": [
+              #         {
+              #           "log_type": "DATA_READ",
+              #           "exempted_members": [
+              #             "user:jose@example.com"
+              #           ]
+              #         },
+              #         {
+              #           "log_type": "DATA_WRITE"
+              #         }
+              #       ]
+              #     }
+              #
+              # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
+              # jose@example.com from DATA_READ logging.
+            "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
+                # permission.
+                # Follows the same format of Binding.members.
+              "A String",
+            ],
+            "logType": "A String", # The log type that this config enables.
+          },
+        ],
+        "service": "A String", # Specifies a service that will be enabled for audit logging.
+            # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
+            # `allServices` is a special value that covers all services.
+      },
+    ],
+    "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally,
+        # may specify a `condition` that determines how and when the `bindings` are
+        # applied. Each of the `bindings` must contain at least one principal.
+        #
+        # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
+        # of these principals can be Google groups. Each occurrence of a principal
+        # counts towards these limits. For example, if the `bindings` grant 50
+        # different roles to `user:alice@example.com`, and not to any other
+        # principal, then you can add another 1,450 principals to the `bindings` in
+        # the `Policy`.
+      { # Associates `members`, or principals, with a `role`.
+        "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
+            #
+            # If the condition evaluates to `true`, then this binding applies to the
+            # current request.
+            #
+            # If the condition evaluates to `false`, then this binding does not apply to
+            # the current request. However, a different role binding might grant the same
+            # role to one or more of the principals in this binding.
+            #
+            # To learn which resources support conditions in their IAM policies, see the
+            # [IAM
+            # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+            # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
+            # are documented at https://github.com/google/cel-spec.
+            #
+            # Example (Comparison):
+            #
+            #     title: "Summary size limit"
+            #     description: "Determines if a summary is less than 100 chars"
+            #     expression: "document.summary.size() < 100"
+            #
+            # Example (Equality):
+            #
+            #     title: "Requestor is owner"
+            #     description: "Determines if requestor is the document owner"
+            #     expression: "document.owner == request.auth.claims.email"
+            #
+            # Example (Logic):
+            #
+            #     title: "Public documents"
+            #     description: "Determine whether the document should be publicly visible"
+            #     expression: "document.type != 'private' && document.type != 'internal'"
+            #
+            # Example (Data Manipulation):
+            #
+            #     title: "Notification string"
+            #     description: "Create a notification string with a timestamp."
+            #     expression: "'New message received at ' + string(document.create_time)"
+            #
+            # The exact variables and functions that may be referenced within an expression
+            # are determined by the service that evaluates it. See the service
+            # documentation for additional information.
+          "description": "A String", # Optional. Description of the expression. This is a longer text which
+              # describes the expression, e.g. when hovered over it in a UI.
+          "expression": "A String", # Textual representation of an expression in Common Expression Language
+              # syntax.
+          "location": "A String", # Optional. String indicating the location of the expression for error
+              # reporting, e.g. a file name and a position in the file.
+          "title": "A String", # Optional. Title for the expression, i.e. a short string describing
+              # its purpose. This can be used e.g. in UIs which allow to enter the
+              # expression.
+        },
+        "members": [ # Specifies the principals requesting access for a Google Cloud resource.
+            # `members` can have the following values:
+            #
+            # * `allUsers`: A special identifier that represents anyone who is
+            #    on the internet; with or without a Google account.
+            #
+            # * `allAuthenticatedUsers`: A special identifier that represents anyone
+            #    who is authenticated with a Google account or a service account.
+            #    Does not include identities that come from external identity providers
+            #    (IdPs) through identity federation.
+            #
+            # * `user:{emailid}`: An email address that represents a specific Google
+            #    account. For example, `alice@example.com` .
+            #
+            #
+            # * `serviceAccount:{emailid}`: An email address that represents a Google
+            #    service account. For example,
+            #    `my-other-app@appspot.gserviceaccount.com`.
+            #
+            # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
+            #    identifier for a
+            #    [Kubernetes service
+            #    account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
+            #    For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
+            #
+            # * `group:{emailid}`: An email address that represents a Google group.
+            #    For example, `admins@example.com`.
+            #
+            #
+            # * `domain:{domain}`: The G Suite domain (primary) that represents all the
+            #    users of that domain. For example, `google.com` or `example.com`.
+            #
+            #
+            #
+            #
+            # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
+            #   A single identity in a workforce identity pool.
+            #
+            # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
+            #   All workforce identities in a group.
+            #
+            # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
+            #   All workforce identities with a specific attribute value.
+            #
+            # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
+            #   All identities in a workforce identity pool.
+            #
+            # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
+            #   A single identity in a workload identity pool.
+            #
+            # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
+            #   A workload identity pool group.
+            #
+            # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
+            #   All identities in a workload identity pool with a certain attribute.
+            #
+            # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
+            #   All identities in a workload identity pool.
+            #
+            # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
+            #    identifier) representing a user that has been recently deleted. For
+            #    example, `alice@example.com?uid=123456789012345678901`. If the user is
+            #    recovered, this value reverts to `user:{emailid}` and the recovered user
+            #    retains the role in the binding.
+            #
+            # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
+            #    unique identifier) representing a service account that has been recently
+            #    deleted. For example,
+            #    `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
+            #    If the service account is undeleted, this value reverts to
+            #    `serviceAccount:{emailid}` and the undeleted service account retains the
+            #    role in the binding.
+            #
+            # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
+            #    identifier) representing a Google group that has been recently
+            #    deleted. For example, `admins@example.com?uid=123456789012345678901`. If
+            #    the group is recovered, this value reverts to `group:{emailid}` and the
+            #    recovered group retains the role in the binding.
+            #
+            # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
+            #   Deleted single identity in a workforce identity pool. For example,
+            #   `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+          "A String",
+        ],
+        "role": "A String", # Role that is assigned to the list of `members`, or principals.
+            # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+            #
+            # For an overview of the IAM roles and permissions, see the
+            # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
+            # a list of the available pre-defined roles, see
+            # [here](https://cloud.google.com/iam/docs/understanding-roles).
+      },
+    ],
+    "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
+        # prevent simultaneous updates of a policy from overwriting each other.
+        # It is strongly suggested that systems make use of the `etag` in the
+        # read-modify-write cycle to perform policy updates in order to avoid race
+        # conditions: An `etag` is returned in the response to `getIamPolicy`, and
+        # systems are expected to put that etag in the request to `setIamPolicy` to
+        # ensure that their change will be applied to the same version of the policy.
+        #
+        # **Important:** If you use IAM Conditions, you must include the `etag` field
+        # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+        # you to overwrite a version `3` policy with a version `1` policy, and all of
+        # the conditions in the version `3` policy are lost.
+    "version": 42, # Specifies the format of the policy.
+        #
+        # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
+        # are rejected.
+        #
+        # Any operation that affects conditional role bindings must specify version
+        # `3`. This requirement applies to the following operations:
+        #
+        # * Getting a policy that includes a conditional role binding
+        # * Adding a conditional role binding to a policy
+        # * Changing a conditional role binding in a policy
+        # * Removing any role binding, with or without a condition, from a policy
+        #   that includes conditions
+        #
+        # **Important:** If you use IAM Conditions, you must include the `etag` field
+        # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+        # you to overwrite a version `3` policy with a version `1` policy, and all of
+        # the conditions in the version `3` policy are lost.
+        #
+        # If a policy does not include any conditions, operations on that policy may
+        # specify any valid version or leave the field unset.
+        #
+        # To learn which resources support conditions in their IAM policies, see the
+        # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An Identity and Access Management (IAM) policy, which specifies access
+    # controls for Google Cloud resources.
+    #
+    #
+    # A `Policy` is a collection of `bindings`. A `binding` binds one or more
+    # `members`, or principals, to a single `role`. Principals can be user
+    # accounts, service accounts, Google groups, and domains (such as G Suite). A
+    # `role` is a named list of permissions; each `role` can be an IAM predefined
+    # role or a user-created custom role.
+    #
+    # For some types of Google Cloud resources, a `binding` can also specify a
+    # `condition`, which is a logical expression that allows access to a resource
+    # only if the expression evaluates to `true`. A condition can add constraints
+    # based on attributes of the request, the resource, or both. To learn which
+    # resources support conditions in their IAM policies, see the
+    # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+    #
+    # **JSON example:**
+    #
+    # ```
+    #     {
+    #       "bindings": [
+    #         {
+    #           "role": "roles/resourcemanager.organizationAdmin",
+    #           "members": [
+    #             "user:mike@example.com",
+    #             "group:admins@example.com",
+    #             "domain:google.com",
+    #             "serviceAccount:my-project-id@appspot.gserviceaccount.com"
+    #           ]
+    #         },
+    #         {
+    #           "role": "roles/resourcemanager.organizationViewer",
+    #           "members": [
+    #             "user:eve@example.com"
+    #           ],
+    #           "condition": {
+    #             "title": "expirable access",
+    #             "description": "Does not grant access after Sep 2020",
+    #             "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
+    #           }
+    #         }
+    #       ],
+    #       "etag": "BwWWja0YfJA=",
+    #       "version": 3
+    #     }
+    # ```
+    #
+    # **YAML example:**
+    #
+    # ```
+    #     bindings:
+    #     - members:
+    #       - user:mike@example.com
+    #       - group:admins@example.com
+    #       - domain:google.com
+    #       - serviceAccount:my-project-id@appspot.gserviceaccount.com
+    #       role: roles/resourcemanager.organizationAdmin
+    #     - members:
+    #       - user:eve@example.com
+    #       role: roles/resourcemanager.organizationViewer
+    #       condition:
+    #         title: expirable access
+    #         description: Does not grant access after Sep 2020
+    #         expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
+    #     etag: BwWWja0YfJA=
+    #     version: 3
+    # ```
+    #
+    # For a description of IAM and its features, see the
+    # [IAM documentation](https://cloud.google.com/iam/docs/).
+  "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+    { # Specifies the audit configuration for a service.
+        # The configuration determines which permission types are logged, and what
+        # identities, if any, are exempted from logging.
+        # An AuditConfig must have one or more AuditLogConfigs.
+        #
+        # If there are AuditConfigs for both `allServices` and a specific service,
+        # the union of the two AuditConfigs is used for that service: the log_types
+        # specified in each AuditConfig are enabled, and the exempted_members in each
+        # AuditLogConfig are exempted.
+        #
+        # Example Policy with multiple AuditConfigs:
+        #
+        #     {
+        #       "audit_configs": [
+        #         {
+        #           "service": "allServices",
+        #           "audit_log_configs": [
+        #             {
+        #               "log_type": "DATA_READ",
+        #               "exempted_members": [
+        #                 "user:jose@example.com"
+        #               ]
+        #             },
+        #             {
+        #               "log_type": "DATA_WRITE"
+        #             },
+        #             {
+        #               "log_type": "ADMIN_READ"
+        #             }
+        #           ]
+        #         },
+        #         {
+        #           "service": "sampleservice.googleapis.com",
+        #           "audit_log_configs": [
+        #             {
+        #               "log_type": "DATA_READ"
+        #             },
+        #             {
+        #               "log_type": "DATA_WRITE",
+        #               "exempted_members": [
+        #                 "user:aliya@example.com"
+        #               ]
+        #             }
+        #           ]
+        #         }
+        #       ]
+        #     }
+        #
+        # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
+        # logging. It also exempts `jose@example.com` from DATA_READ logging, and
+        # `aliya@example.com` from DATA_WRITE logging.
+      "auditLogConfigs": [ # The configuration for logging of each type of permission.
+        { # Provides the configuration for logging a type of permissions.
+            # Example:
+            #
+            #     {
+            #       "audit_log_configs": [
+            #         {
+            #           "log_type": "DATA_READ",
+            #           "exempted_members": [
+            #             "user:jose@example.com"
+            #           ]
+            #         },
+            #         {
+            #           "log_type": "DATA_WRITE"
+            #         }
+            #       ]
+            #     }
+            #
+            # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
+            # jose@example.com from DATA_READ logging.
+          "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
+              # permission.
+              # Follows the same format of Binding.members.
+            "A String",
+          ],
+          "logType": "A String", # The log type that this config enables.
+        },
+      ],
+      "service": "A String", # Specifies a service that will be enabled for audit logging.
+          # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
+          # `allServices` is a special value that covers all services.
+    },
+  ],
+  "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally,
+      # may specify a `condition` that determines how and when the `bindings` are
+      # applied. Each of the `bindings` must contain at least one principal.
+      #
+      # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
+      # of these principals can be Google groups. Each occurrence of a principal
+      # counts towards these limits. For example, if the `bindings` grant 50
+      # different roles to `user:alice@example.com`, and not to any other
+      # principal, then you can add another 1,450 principals to the `bindings` in
+      # the `Policy`.
+    { # Associates `members`, or principals, with a `role`.
+      "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
+          #
+          # If the condition evaluates to `true`, then this binding applies to the
+          # current request.
+          #
+          # If the condition evaluates to `false`, then this binding does not apply to
+          # the current request. However, a different role binding might grant the same
+          # role to one or more of the principals in this binding.
+          #
+          # To learn which resources support conditions in their IAM policies, see the
+          # [IAM
+          # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+          # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
+          # are documented at https://github.com/google/cel-spec.
+          #
+          # Example (Comparison):
+          #
+          #     title: "Summary size limit"
+          #     description: "Determines if a summary is less than 100 chars"
+          #     expression: "document.summary.size() < 100"
+          #
+          # Example (Equality):
+          #
+          #     title: "Requestor is owner"
+          #     description: "Determines if requestor is the document owner"
+          #     expression: "document.owner == request.auth.claims.email"
+          #
+          # Example (Logic):
+          #
+          #     title: "Public documents"
+          #     description: "Determine whether the document should be publicly visible"
+          #     expression: "document.type != 'private' && document.type != 'internal'"
+          #
+          # Example (Data Manipulation):
+          #
+          #     title: "Notification string"
+          #     description: "Create a notification string with a timestamp."
+          #     expression: "'New message received at ' + string(document.create_time)"
+          #
+          # The exact variables and functions that may be referenced within an expression
+          # are determined by the service that evaluates it. See the service
+          # documentation for additional information.
+        "description": "A String", # Optional. Description of the expression. This is a longer text which
+            # describes the expression, e.g. when hovered over it in a UI.
+        "expression": "A String", # Textual representation of an expression in Common Expression Language
+            # syntax.
+        "location": "A String", # Optional. String indicating the location of the expression for error
+            # reporting, e.g. a file name and a position in the file.
+        "title": "A String", # Optional. Title for the expression, i.e. a short string describing
+            # its purpose. This can be used e.g. in UIs which allow to enter the
+            # expression.
+      },
+      "members": [ # Specifies the principals requesting access for a Google Cloud resource.
+          # `members` can have the following values:
+          #
+          # * `allUsers`: A special identifier that represents anyone who is
+          #    on the internet; with or without a Google account.
+          #
+          # * `allAuthenticatedUsers`: A special identifier that represents anyone
+          #    who is authenticated with a Google account or a service account.
+          #    Does not include identities that come from external identity providers
+          #    (IdPs) through identity federation.
+          #
+          # * `user:{emailid}`: An email address that represents a specific Google
+          #    account. For example, `alice@example.com` .
+          #
+          #
+          # * `serviceAccount:{emailid}`: An email address that represents a Google
+          #    service account. For example,
+          #    `my-other-app@appspot.gserviceaccount.com`.
+          #
+          # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
+          #    identifier for a
+          #    [Kubernetes service
+          #    account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
+          #    For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
+          #
+          # * `group:{emailid}`: An email address that represents a Google group.
+          #    For example, `admins@example.com`.
+          #
+          #
+          # * `domain:{domain}`: The G Suite domain (primary) that represents all the
+          #    users of that domain. For example, `google.com` or `example.com`.
+          #
+          #
+          #
+          #
+          # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
+          #   A single identity in a workforce identity pool.
+          #
+          # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
+          #   All workforce identities in a group.
+          #
+          # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
+          #   All workforce identities with a specific attribute value.
+          #
+          # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
+          #   All identities in a workforce identity pool.
+          #
+          # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
+          #   A single identity in a workload identity pool.
+          #
+          # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
+          #   A workload identity pool group.
+          #
+          # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
+          #   All identities in a workload identity pool with a certain attribute.
+          #
+          # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
+          #   All identities in a workload identity pool.
+          #
+          # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
+          #    identifier) representing a user that has been recently deleted. For
+          #    example, `alice@example.com?uid=123456789012345678901`. If the user is
+          #    recovered, this value reverts to `user:{emailid}` and the recovered user
+          #    retains the role in the binding.
+          #
+          # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
+          #    unique identifier) representing a service account that has been recently
+          #    deleted. For example,
+          #    `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
+          #    If the service account is undeleted, this value reverts to
+          #    `serviceAccount:{emailid}` and the undeleted service account retains the
+          #    role in the binding.
+          #
+          # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
+          #    identifier) representing a Google group that has been recently
+          #    deleted. For example, `admins@example.com?uid=123456789012345678901`. If
+          #    the group is recovered, this value reverts to `group:{emailid}` and the
+          #    recovered group retains the role in the binding.
+          #
+          # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
+          #   Deleted single identity in a workforce identity pool. For example,
+          #   `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+        "A String",
+      ],
+      "role": "A String", # Role that is assigned to the list of `members`, or principals.
+          # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+          #
+          # For an overview of the IAM roles and permissions, see the
+          # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
+          # a list of the available pre-defined roles, see
+          # [here](https://cloud.google.com/iam/docs/understanding-roles).
+    },
+  ],
+  "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
+      # prevent simultaneous updates of a policy from overwriting each other.
+      # It is strongly suggested that systems make use of the `etag` in the
+      # read-modify-write cycle to perform policy updates in order to avoid race
+      # conditions: An `etag` is returned in the response to `getIamPolicy`, and
+      # systems are expected to put that etag in the request to `setIamPolicy` to
+      # ensure that their change will be applied to the same version of the policy.
+      #
+      # **Important:** If you use IAM Conditions, you must include the `etag` field
+      # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+      # you to overwrite a version `3` policy with a version `1` policy, and all of
+      # the conditions in the version `3` policy are lost.
+  "version": 42, # Specifies the format of the policy.
+      #
+      # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
+      # are rejected.
+      #
+      # Any operation that affects conditional role bindings must specify version
+      # `3`. This requirement applies to the following operations:
+      #
+      # * Getting a policy that includes a conditional role binding
+      # * Adding a conditional role binding to a policy
+      # * Changing a conditional role binding in a policy
+      # * Removing any role binding, with or without a condition, from a policy
+      #   that includes conditions
+      #
+      # **Important:** If you use IAM Conditions, you must include the `etag` field
+      # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+      # you to overwrite a version `3` policy with a version `1` policy, and all of
+      # the conditions in the version `3` policy are lost.
+      #
+      # If a policy does not include any conditions, operations on that policy may
+      # specify any valid version or leave the field unset.
+      #
+      # To learn which resources support conditions in their IAM policies, see the
+      # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+}
+
+ +
+ setLabels(project, region, resource, body=None, requestId=None, x__xgafv=None) +
Sets the labels on a regional snapshot. To learn more about labels, read
+the Labeling Resources
+documentation.
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, The region for this request. (required)
+  resource: string, Name or id of the resource for this request. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{
+  "labelFingerprint": "A String", # The fingerprint of the previous set of labels for this resource,
+      # used to detect conflicts. The fingerprint is initially generated by Compute
+      # Engine and changes after every request to modify or update labels. You must
+      # always provide an up-to-date fingerprint hash in order to update or change
+      # labels. Make a get() request to the resource to get the latest
+      # fingerprint.
+  "labels": { # The labels to set for this resource.
+    "a_key": "A String",
+  },
+}
+
+  requestId: string, An optional request ID to identify requests. Specify a unique request ID so
+that if you must retry your request, the server will know to ignore the
+request if it has already been completed.
+
+For example, consider a situation where you make an initial request and
+the request times out. If you make the request again with the same
+request ID, the server can check if original operation with the same
+request ID was received, and if so, will ignore the second request. This
+prevents clients from accidentally creating duplicate commitments.
+
+The request ID must be
+a valid UUID with the exception that zero UUID is not supported
+(00000000-0000-0000-0000-000000000000).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an Operation resource.
+    #
+    # Google Compute Engine has three Operation resources:
+    #
+    # * [Global](/compute/docs/reference/rest/v1/globalOperations)
+    # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
+    # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
+    #
+    # You can use an operation resource to manage asynchronous API requests.
+    # For more information, readHandling
+    # API responses.
+    #
+    # Operations can be global, regional or zonal.
+    #
+    #    - For global operations, use the `globalOperations`
+    #    resource.
+    #    - For regional operations, use the
+    #    `regionOperations` resource.
+    #    - For zonal operations, use
+    #    the `zoneOperations` resource.
+    #
+    #
+    #
+    # For more information, read
+    # Global, Regional, and Zonal Resources.
+    #
+    # Note that completed Operation resources have a limited
+    # retention period.
+  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
+      # Not present otherwise.
+  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+  "description": "A String", # [Output Only] A textual description of the operation, which is
+      # set when the operation is created.
+  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
+      # text format.
+  "error": { # [Output Only] If errors are generated during processing of the operation,
+      # this field will be populated.
+    "errors": [ # [Output Only] The array of errors encountered while processing this
+        # operation.
+      {
+        "code": "A String", # [Output Only] The error type identifier for this error.
+        "errorDetails": [ # [Output Only] An optional list of messages that contain the error
+            # details. There is a set of defined message types to use for providing
+            # details.The syntax depends on the error code. For example,
+            # QuotaExceededInfo will have details when the error code is
+            # QUOTA_EXCEEDED.
+          {
+            "errorInfo": { # Describes the cause of the error with structured details.
+                #
+                # Example of an error when contacting the "pubsub.googleapis.com" API when it
+                # is not enabled:
+                #
+                #     { "reason": "API_DISABLED"
+                #       "domain": "googleapis.com"
+                #       "metadata": {
+                #         "resource": "projects/123",
+                #         "service": "pubsub.googleapis.com"
+                #       }
+                #     }
+                #
+                # This response indicates that the pubsub.googleapis.com API is not enabled.
+                #
+                # Example of an error that is returned when attempting to create a Spanner
+                # instance in a region that is out of stock:
+                #
+                #     { "reason": "STOCKOUT"
+                #       "domain": "spanner.googleapis.com",
+                #       "metadata": {
+                #         "availableRegions": "us-central1,us-east2"
+                #       }
+                #     }
+              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+                  # is typically the registered service name of the tool or product that
+                  # generates the error. Example: "pubsub.googleapis.com". If the error is
+                  # generated by some common infrastructure, the error domain must be a
+                  # globally unique value that identifies the infrastructure. For Google API
+                  # infrastructure, the error domain is "googleapis.com".
+              "metadatas": { # Additional structured details about this error.
+                  #
+                  # Keys must match a regular expression of `a-z+` but should
+                  # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+                  # length. When identifying the current value of an exceeded limit, the units
+                  # should be contained in the key, not the value.  For example, rather than
+                  # `{"instanceLimit": "100/request"}`, should be returned as,
+                  # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+                  # instances that can be created in a single (batch) request.
+                "a_key": "A String",
+              },
+              "reason": "A String", # The reason of the error. This is a constant value that identifies the
+                  # proximate cause of the error. Error reasons are unique within a particular
+                  # domain of errors. This should be at most 63 characters and match a
+                  # regular expression of `A-Z+[A-Z0-9]`, which represents
+                  # UPPER_SNAKE_CASE.
+            },
+            "help": { # Provides links to documentation or for performing an out of band action.
+                #
+                # For example, if a quota check failed with an error indicating the calling
+                # project hasn't enabled the accessed service, this can contain a URL pointing
+                # directly to the right place in the developer console to flip the bit.
+              "links": [ # URL(s) pointing to additional information on handling the current error.
+                { # Describes a URL link.
+                  "description": "A String", # Describes what the link offers.
+                  "url": "A String", # The URL of the link.
+                },
+              ],
+            },
+            "localizedMessage": { # Provides a localized error message that is safe to return to the user
+                # which can be attached to an RPC error.
+              "locale": "A String", # The locale used following the specification defined at
+                  # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+                  # Examples are: "en-US", "fr-CH", "es-MX"
+              "message": "A String", # The localized error message in the above locale.
+            },
+            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+              "dimensions": { # The map holding related quota dimensions.
+                "a_key": "A String",
+              },
+              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+                  #  type or metric.
+              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+                  # or metric.
+              "limitName": "A String", # The name of the quota limit.
+              "metricName": "A String", # The Compute Engine quota metric name.
+              "rolloutStatus": "A String", # Rollout status of the future quota limit.
+            },
+          },
+        ],
+        "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+            # This property is optional.
+        "message": "A String", # [Output Only] An optional, human-readable error message.
+      },
+    ],
+  },
+  "getVersionOperationMetadata": {
+    "inlineSbomInfo": {
+      "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+          # name and the value is the version.
+        "a_key": "A String",
+      },
+      "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+          # component name and the value is the version.
+        "a_key": "A String",
+      },
+    },
+  },
+  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
+      # message that was returned, such as `NOT FOUND`.
+  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
+      # status code that was returned. For example, a `404` means the
+      # resource was not found.
+  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
+      # defined by the server.
+  "insertTime": "A String", # [Output Only] The time that this operation was requested.
+      # This value is inRFC3339
+      # text format.
+  "instancesBulkInsertOperationMetadata": {
+    "perLocationStatus": { # Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
+            # error.
+        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
+            # if the flow is rolling forward or rolling back.
+        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+      },
+    },
+  },
+  "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
+      # Operation resources.
+  "name": "A String", # [Output Only] Name of the operation.
+  "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
+      # group of operations results from a `bulkInsert` API request.
+  "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
+      # `update`, or `delete`, and so on.
+  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
+      # There is no requirement that this be linear or support any granularity of
+      # operations. This should not be used to guess when the operation will be
+      # complete. This number should monotonically increase as the operation
+      # progresses.
+  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
+      # applicable when performing regional operations.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
+      # this field will contain information on all underlying zonal actions and
+      # their state.
+    "clientOperationId": "A String", # [Output Only] The client operation id.
+    "perLocationOperations": { # [Output Only] Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
+            # populated.
+            # different programming environments, including REST APIs and RPC APIs. It is
+            # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+            # three pieces of data: error code, error message, and error details.
+            #
+            # You can find out more about this error model and how to work with it in the
+            # [API Design Guide](https://cloud.google.com/apis/design/errors).
+          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+          "details": [ # A list of messages that carry the error details.  There is a common set of
+              # message types for APIs to use.
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+          "message": "A String", # A developer-facing error message, which should be in English. Any
+              # user-facing error message should be localized and sent in the
+              # google.rpc.Status.details field, or localized by the client.
+        },
+        "state": "A String", # [Output Only] Status of the action, which can be one of the following:
+            # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+      },
+    },
+  },
+  "startTime": "A String", # [Output Only] The time that this operation was started by the server.
+      # This value is inRFC3339
+      # text format.
+  "status": "A String", # [Output Only] The status of the operation, which can be one of the
+      # following:
+      # `PENDING`, `RUNNING`, or `DONE`.
+  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
+      # operation.
+  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
+      # of the target resource.
+  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
+      # operations related to creating a snapshot, this points to the disk
+      # that the snapshot was created from.
+  "user": "A String", # [Output Only] User who requested the operation, for example:
+      # `user@example.com` or
+      # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+  "warnings": [ # [Output Only] If warning messages are generated during processing of the
+      # operation, this field will be populated.
+    {
+      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+          # Engine returns NO_RESULTS_ON_PAGE if there
+          # are no results in the response.
+      "data": [ # [Output Only] Metadata about this warning in key:
+          # value format. For example:
+          #
+          # "data": [
+          #   {
+          #    "key": "scope",
+          #    "value": "zones/us-east1-d"
+          #   }
+        {
+          "key": "A String", # [Output Only] A key that provides more detail on the warning being
+              # returned. For example, for warnings where there are no results in a list
+              # request for a particular zone, this key might be scope and
+              # the key value might be the zone name. Other examples might be a key
+              # indicating a deprecated resource and a suggested replacement, or a
+              # warning about invalid network settings (for example, if an instance
+              # attempts to perform IP forwarding but is not enabled for IP forwarding).
+          "value": "A String", # [Output Only] A warning data value corresponding to the key.
+        },
+      ],
+      "message": "A String", # [Output Only] A human-readable description of the warning code.
+    },
+  ],
+  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
+      # applicable when performing per-zone operations.
+}
+
+ +
+ testIamPermissions(project, region, resource, body=None, x__xgafv=None) +
Returns permissions that a caller has on the specified resource.
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, The name of the region for this request. (required)
+  resource: string, Name or id of the resource for this request. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{
+  "permissions": [ # The set of permissions to check for the 'resource'. Permissions with
+      # wildcards (such as '*' or 'storage.*') are not allowed.
+    "A String",
+  ],
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is
+      # allowed.
+    "A String",
+  ],
+}
+
+ +
+ updateKmsKey(project, region, snapshot, body=None, requestId=None, x__xgafv=None) +
Rotates the customer-managed
+encryption key to the latest version for the specified snapshot.
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, Name of the region for this request. (required)
+  snapshot: string, Name of the snapshot resource to update. Should conform to RFC1035. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{
+  "kmsKeyName": "A String", # Optional. The new KMS key to replace the current one on the snapshot. If empty, the
+      # snapshot will be re-encrypted using the primary version of the snapshot's
+      # current KMS key.
+      # 
+      # The KMS key can be provided in the following formats:
+      # 
+      # 
+      #      - projects/project_id/locations/region/keyRings/region/cryptoKeys/key
+}
+
+  requestId: string, An optional request ID to identify requests. Specify a unique request ID so
+that if you must retry your request, the server will know to ignore the
+request if it has already been completed.
+
+For example, consider a situation where you make an initial request and
+the request times out. If you make the request again with the same
+request ID, the server can check if original operation with the same
+request ID was received, and if so, will ignore the second request. This
+prevents clients from accidentally creating duplicate commitments.
+
+The request ID must be
+a valid UUID with the exception that zero UUID is not supported
+(00000000-0000-0000-0000-000000000000).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an Operation resource.
+    #
+    # Google Compute Engine has three Operation resources:
+    #
+    # * [Global](/compute/docs/reference/rest/v1/globalOperations)
+    # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
+    # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
+    #
+    # You can use an operation resource to manage asynchronous API requests.
+    # For more information, readHandling
+    # API responses.
+    #
+    # Operations can be global, regional or zonal.
+    #
+    #    - For global operations, use the `globalOperations`
+    #    resource.
+    #    - For regional operations, use the
+    #    `regionOperations` resource.
+    #    - For zonal operations, use
+    #    the `zoneOperations` resource.
+    #
+    #
+    #
+    # For more information, read
+    # Global, Regional, and Zonal Resources.
+    #
+    # Note that completed Operation resources have a limited
+    # retention period.
+  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
+      # Not present otherwise.
+  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+  "description": "A String", # [Output Only] A textual description of the operation, which is
+      # set when the operation is created.
+  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
+      # text format.
+  "error": { # [Output Only] If errors are generated during processing of the operation,
+      # this field will be populated.
+    "errors": [ # [Output Only] The array of errors encountered while processing this
+        # operation.
+      {
+        "code": "A String", # [Output Only] The error type identifier for this error.
+        "errorDetails": [ # [Output Only] An optional list of messages that contain the error
+            # details. There is a set of defined message types to use for providing
+            # details.The syntax depends on the error code. For example,
+            # QuotaExceededInfo will have details when the error code is
+            # QUOTA_EXCEEDED.
+          {
+            "errorInfo": { # Describes the cause of the error with structured details.
+                #
+                # Example of an error when contacting the "pubsub.googleapis.com" API when it
+                # is not enabled:
+                #
+                #     { "reason": "API_DISABLED"
+                #       "domain": "googleapis.com"
+                #       "metadata": {
+                #         "resource": "projects/123",
+                #         "service": "pubsub.googleapis.com"
+                #       }
+                #     }
+                #
+                # This response indicates that the pubsub.googleapis.com API is not enabled.
+                #
+                # Example of an error that is returned when attempting to create a Spanner
+                # instance in a region that is out of stock:
+                #
+                #     { "reason": "STOCKOUT"
+                #       "domain": "spanner.googleapis.com",
+                #       "metadata": {
+                #         "availableRegions": "us-central1,us-east2"
+                #       }
+                #     }
+              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+                  # is typically the registered service name of the tool or product that
+                  # generates the error. Example: "pubsub.googleapis.com". If the error is
+                  # generated by some common infrastructure, the error domain must be a
+                  # globally unique value that identifies the infrastructure. For Google API
+                  # infrastructure, the error domain is "googleapis.com".
+              "metadatas": { # Additional structured details about this error.
+                  #
+                  # Keys must match a regular expression of `a-z+` but should
+                  # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+                  # length. When identifying the current value of an exceeded limit, the units
+                  # should be contained in the key, not the value.  For example, rather than
+                  # `{"instanceLimit": "100/request"}`, should be returned as,
+                  # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+                  # instances that can be created in a single (batch) request.
+                "a_key": "A String",
+              },
+              "reason": "A String", # The reason of the error. This is a constant value that identifies the
+                  # proximate cause of the error. Error reasons are unique within a particular
+                  # domain of errors. This should be at most 63 characters and match a
+                  # regular expression of `A-Z+[A-Z0-9]`, which represents
+                  # UPPER_SNAKE_CASE.
+            },
+            "help": { # Provides links to documentation or for performing an out of band action.
+                #
+                # For example, if a quota check failed with an error indicating the calling
+                # project hasn't enabled the accessed service, this can contain a URL pointing
+                # directly to the right place in the developer console to flip the bit.
+              "links": [ # URL(s) pointing to additional information on handling the current error.
+                { # Describes a URL link.
+                  "description": "A String", # Describes what the link offers.
+                  "url": "A String", # The URL of the link.
+                },
+              ],
+            },
+            "localizedMessage": { # Provides a localized error message that is safe to return to the user
+                # which can be attached to an RPC error.
+              "locale": "A String", # The locale used following the specification defined at
+                  # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+                  # Examples are: "en-US", "fr-CH", "es-MX"
+              "message": "A String", # The localized error message in the above locale.
+            },
+            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+              "dimensions": { # The map holding related quota dimensions.
+                "a_key": "A String",
+              },
+              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+                  #  type or metric.
+              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+                  # or metric.
+              "limitName": "A String", # The name of the quota limit.
+              "metricName": "A String", # The Compute Engine quota metric name.
+              "rolloutStatus": "A String", # Rollout status of the future quota limit.
+            },
+          },
+        ],
+        "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+            # This property is optional.
+        "message": "A String", # [Output Only] An optional, human-readable error message.
+      },
+    ],
+  },
+  "getVersionOperationMetadata": {
+    "inlineSbomInfo": {
+      "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+          # name and the value is the version.
+        "a_key": "A String",
+      },
+      "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+          # component name and the value is the version.
+        "a_key": "A String",
+      },
+    },
+  },
+  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
+      # message that was returned, such as `NOT FOUND`.
+  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
+      # status code that was returned. For example, a `404` means the
+      # resource was not found.
+  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
+      # defined by the server.
+  "insertTime": "A String", # [Output Only] The time that this operation was requested.
+      # This value is inRFC3339
+      # text format.
+  "instancesBulkInsertOperationMetadata": {
+    "perLocationStatus": { # Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
+            # error.
+        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
+            # if the flow is rolling forward or rolling back.
+        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+      },
+    },
+  },
+  "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
+      # Operation resources.
+  "name": "A String", # [Output Only] Name of the operation.
+  "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
+      # group of operations results from a `bulkInsert` API request.
+  "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
+      # `update`, or `delete`, and so on.
+  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
+      # There is no requirement that this be linear or support any granularity of
+      # operations. This should not be used to guess when the operation will be
+      # complete. This number should monotonically increase as the operation
+      # progresses.
+  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
+      # applicable when performing regional operations.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
+      # this field will contain information on all underlying zonal actions and
+      # their state.
+    "clientOperationId": "A String", # [Output Only] The client operation id.
+    "perLocationOperations": { # [Output Only] Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
+            # populated.
+            # different programming environments, including REST APIs and RPC APIs. It is
+            # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+            # three pieces of data: error code, error message, and error details.
+            #
+            # You can find out more about this error model and how to work with it in the
+            # [API Design Guide](https://cloud.google.com/apis/design/errors).
+          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+          "details": [ # A list of messages that carry the error details.  There is a common set of
+              # message types for APIs to use.
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+          "message": "A String", # A developer-facing error message, which should be in English. Any
+              # user-facing error message should be localized and sent in the
+              # google.rpc.Status.details field, or localized by the client.
+        },
+        "state": "A String", # [Output Only] Status of the action, which can be one of the following:
+            # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+      },
+    },
+  },
+  "startTime": "A String", # [Output Only] The time that this operation was started by the server.
+      # This value is inRFC3339
+      # text format.
+  "status": "A String", # [Output Only] The status of the operation, which can be one of the
+      # following:
+      # `PENDING`, `RUNNING`, or `DONE`.
+  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
+      # operation.
+  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
+      # of the target resource.
+  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
+      # operations related to creating a snapshot, this points to the disk
+      # that the snapshot was created from.
+  "user": "A String", # [Output Only] User who requested the operation, for example:
+      # `user@example.com` or
+      # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+  "warnings": [ # [Output Only] If warning messages are generated during processing of the
+      # operation, this field will be populated.
+    {
+      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+          # Engine returns NO_RESULTS_ON_PAGE if there
+          # are no results in the response.
+      "data": [ # [Output Only] Metadata about this warning in key:
+          # value format. For example:
+          #
+          # "data": [
+          #   {
+          #    "key": "scope",
+          #    "value": "zones/us-east1-d"
+          #   }
+        {
+          "key": "A String", # [Output Only] A key that provides more detail on the warning being
+              # returned. For example, for warnings where there are no results in a list
+              # request for a particular zone, this key might be scope and
+              # the key value might be the zone name. Other examples might be a key
+              # indicating a deprecated resource and a suggested replacement, or a
+              # warning about invalid network settings (for example, if an instance
+              # attempts to perform IP forwarding but is not enabled for IP forwarding).
+          "value": "A String", # [Output Only] A warning data value corresponding to the key.
+        },
+      ],
+      "message": "A String", # [Output Only] A human-readable description of the warning code.
+    },
+  ],
+  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
+      # applicable when performing per-zone operations.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/compute_v1.snapshotSettings.html b/docs/dyn/compute_v1.snapshotSettings.html index 52de139429..7a9d8df4cf 100644 --- a/docs/dyn/compute_v1.snapshotSettings.html +++ b/docs/dyn/compute_v1.snapshotSettings.html @@ -104,6 +104,16 @@

Method Details

An object of the form: { + "accessLocation": { # (Regional snapshots use only)Policy of which location is allowed to access + # snapshot. + "locations": { # List of regions that can restore a regional + # snapshot from the current region + "a_key": { # A structure for specifying an allowed target region. + "region": "A String", # Accessible region name + }, + }, + "policy": "A String", # Policy of which location is allowed to access snapshot. + }, "storageLocation": { # Policy of which storage location is going to be resolved, and additional # data that particularizes how the policy is going to be carried out. "locations": { # When the policy is SPECIFIC_LOCATIONS, snapshots will be stored @@ -129,6 +139,16 @@

Method Details

The object takes the form of: { + "accessLocation": { # (Regional snapshots use only)Policy of which location is allowed to access + # snapshot. + "locations": { # List of regions that can restore a regional + # snapshot from the current region + "a_key": { # A structure for specifying an allowed target region. + "region": "A String", # Accessible region name + }, + }, + "policy": "A String", # Policy of which location is allowed to access snapshot. + }, "storageLocation": { # Policy of which storage location is going to be resolved, and additional # data that particularizes how the policy is going to be carried out. "locations": { # When the policy is SPECIFIC_LOCATIONS, snapshots will be stored diff --git a/docs/dyn/compute_v1.snapshots.html b/docs/dyn/compute_v1.snapshots.html index b6791194c8..689c634b4b 100644 --- a/docs/dyn/compute_v1.snapshots.html +++ b/docs/dyn/compute_v1.snapshots.html @@ -529,6 +529,8 @@

Method Details

"a_key": "A String", }, }, + "region": "A String", # Output only. [Output Only] URL of the region where the snapshot resides. Only applicable + # for regional snapshots. "satisfiesPzi": True or False, # Output only. Reserved for future use. "satisfiesPzs": True or False, # Output only. [Output Only] Reserved for future use. "selfLink": "A String", # Output only. [Output Only] Server-defined URL for the resource. @@ -597,6 +599,10 @@

Method Details

# 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, + "snapshotGroupId": "A String", # Output only. [Output Only] The unique ID of the snapshot group that this snapshot + # belongs to. The usage of snapshot group feature is restricted. + "snapshotGroupName": "A String", # Output only. [Output only] The snapshot group that this snapshot belongs to. The usage + # of snapshot group feature is restricted. "snapshotType": "A String", # Indicates the type of the snapshot. "sourceDisk": "A String", # The source disk used to create this snapshot. "sourceDiskEncryptionKey": { # The customer-supplied @@ -1228,6 +1234,8 @@

Method Details

"a_key": "A String", }, }, + "region": "A String", # Output only. [Output Only] URL of the region where the snapshot resides. Only applicable + # for regional snapshots. "satisfiesPzi": True or False, # Output only. Reserved for future use. "satisfiesPzs": True or False, # Output only. [Output Only] Reserved for future use. "selfLink": "A String", # Output only. [Output Only] Server-defined URL for the resource. @@ -1296,6 +1304,10 @@

Method Details

# 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, + "snapshotGroupId": "A String", # Output only. [Output Only] The unique ID of the snapshot group that this snapshot + # belongs to. The usage of snapshot group feature is restricted. + "snapshotGroupName": "A String", # Output only. [Output only] The snapshot group that this snapshot belongs to. The usage + # of snapshot group feature is restricted. "snapshotType": "A String", # Indicates the type of the snapshot. "sourceDisk": "A String", # The source disk used to create this snapshot. "sourceDiskEncryptionKey": { # The customer-supplied @@ -1931,6 +1943,8 @@

Method Details

"a_key": "A String", }, }, + "region": "A String", # Output only. [Output Only] URL of the region where the snapshot resides. Only applicable + # for regional snapshots. "satisfiesPzi": True or False, # Output only. Reserved for future use. "satisfiesPzs": True or False, # Output only. [Output Only] Reserved for future use. "selfLink": "A String", # Output only. [Output Only] Server-defined URL for the resource. @@ -1999,6 +2013,10 @@

Method Details

# 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, + "snapshotGroupId": "A String", # Output only. [Output Only] The unique ID of the snapshot group that this snapshot + # belongs to. The usage of snapshot group feature is restricted. + "snapshotGroupName": "A String", # Output only. [Output only] The snapshot group that this snapshot belongs to. The usage + # of snapshot group feature is restricted. "snapshotType": "A String", # Indicates the type of the snapshot. "sourceDisk": "A String", # The source disk used to create this snapshot. "sourceDiskEncryptionKey": { # The customer-supplied diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.html b/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.html index 7202330ee6..119943597c 100644 --- a/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.html +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.html @@ -135,6 +135,7 @@

Method Details

"deploymentId": "A String", # The agent's deployment ID. Only applicable to automated agents. "displayName": "A String", # The agent's name. "dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call. + "entrySubagentDisplayName": "A String", # The entry subagent's display name. "location": "A String", # The agent's location. "team": "A String", # A user-specified string representing the agent's team. Deprecated in favor of the `teams` field. "teams": [ # User-specified strings representing the agent's teams. @@ -172,6 +173,7 @@

Method Details

"deploymentId": "A String", # The agent's deployment ID. Only applicable to automated agents. "displayName": "A String", # The agent's name. "dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call. + "entrySubagentDisplayName": "A String", # The entry subagent's display name. "location": "A String", # The agent's location. "team": "A String", # A user-specified string representing the agent's team. Deprecated in favor of the `teams` field. "teams": [ # User-specified strings representing the agent's teams. @@ -202,6 +204,7 @@

Method Details

"deploymentId": "A String", # The agent's deployment ID. Only applicable to automated agents. "displayName": "A String", # The agent's name. "dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call. + "entrySubagentDisplayName": "A String", # The entry subagent's display name. "location": "A String", # The agent's location. "team": "A String", # A user-specified string representing the agent's team. Deprecated in favor of the `teams` field. "teams": [ # User-specified strings representing the agent's teams. @@ -264,6 +267,7 @@

Method Details

"deploymentId": "A String", # The agent's deployment ID. Only applicable to automated agents. "displayName": "A String", # The agent's name. "dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call. + "entrySubagentDisplayName": "A String", # The entry subagent's display name. "location": "A String", # The agent's location. "team": "A String", # A user-specified string representing the agent's team. Deprecated in favor of the `teams` field. "teams": [ # User-specified strings representing the agent's teams. @@ -301,6 +305,7 @@

Method Details

"deploymentId": "A String", # The agent's deployment ID. Only applicable to automated agents. "displayName": "A String", # The agent's name. "dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call. + "entrySubagentDisplayName": "A String", # The entry subagent's display name. "location": "A String", # The agent's location. "team": "A String", # A user-specified string representing the agent's team. Deprecated in favor of the `teams` field. "teams": [ # User-specified strings representing the agent's teams. @@ -343,6 +348,7 @@

Method Details

"deploymentId": "A String", # The agent's deployment ID. Only applicable to automated agents. "displayName": "A String", # The agent's name. "dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call. + "entrySubagentDisplayName": "A String", # The entry subagent's display name. "location": "A String", # The agent's location. "team": "A String", # A user-specified string representing the agent's team. Deprecated in favor of the `teams` field. "teams": [ # User-specified strings representing the agent's teams. @@ -403,6 +409,7 @@

Method Details

"deploymentId": "A String", # The agent's deployment ID. Only applicable to automated agents. "displayName": "A String", # The agent's name. "dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call. + "entrySubagentDisplayName": "A String", # The entry subagent's display name. "location": "A String", # The agent's location. "team": "A String", # A user-specified string representing the agent's team. Deprecated in favor of the `teams` field. "teams": [ # User-specified strings representing the agent's teams. diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.authorizedViews.conversations.html b/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.authorizedViews.conversations.html index b94c4fcc37..0a12c82ca4 100644 --- a/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.authorizedViews.conversations.html +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.authorizedViews.conversations.html @@ -499,6 +499,7 @@

Method Details

"deploymentId": "A String", # The agent's deployment ID. Only applicable to automated agents. "displayName": "A String", # The agent's name. "dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call. + "entrySubagentDisplayName": "A String", # The entry subagent's display name. "location": "A String", # The agent's location. "team": "A String", # A user-specified string representing the agent's team. Deprecated in favor of the `teams` field. "teams": [ # User-specified strings representing the agent's teams. @@ -953,6 +954,7 @@

Method Details

"deploymentId": "A String", # The agent's deployment ID. Only applicable to automated agents. "displayName": "A String", # The agent's name. "dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call. + "entrySubagentDisplayName": "A String", # The entry subagent's display name. "location": "A String", # The agent's location. "team": "A String", # A user-specified string representing the agent's team. Deprecated in favor of the `teams` field. "teams": [ # User-specified strings representing the agent's teams. diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.autoLabelingRules.html b/docs/dyn/contactcenterinsights_v1.projects.locations.autoLabelingRules.html index 6e3b5adeb1..58fbfec0fd 100644 --- a/docs/dyn/contactcenterinsights_v1.projects.locations.autoLabelingRules.html +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.autoLabelingRules.html @@ -614,6 +614,7 @@

Method Details

"deploymentId": "A String", # The agent's deployment ID. Only applicable to automated agents. "displayName": "A String", # The agent's name. "dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call. + "entrySubagentDisplayName": "A String", # The entry subagent's display name. "location": "A String", # The agent's location. "team": "A String", # A user-specified string representing the agent's team. Deprecated in favor of the `teams` field. "teams": [ # User-specified strings representing the agent's teams. diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.assessments.html b/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.assessments.html index e01b19affe..656a75046e 100644 --- a/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.assessments.html +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.assessments.html @@ -135,6 +135,7 @@

Method Details

"deploymentId": "A String", # The agent's deployment ID. Only applicable to automated agents. "displayName": "A String", # The agent's name. "dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call. + "entrySubagentDisplayName": "A String", # The entry subagent's display name. "location": "A String", # The agent's location. "team": "A String", # A user-specified string representing the agent's team. Deprecated in favor of the `teams` field. "teams": [ # User-specified strings representing the agent's teams. @@ -172,6 +173,7 @@

Method Details

"deploymentId": "A String", # The agent's deployment ID. Only applicable to automated agents. "displayName": "A String", # The agent's name. "dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call. + "entrySubagentDisplayName": "A String", # The entry subagent's display name. "location": "A String", # The agent's location. "team": "A String", # A user-specified string representing the agent's team. Deprecated in favor of the `teams` field. "teams": [ # User-specified strings representing the agent's teams. @@ -202,6 +204,7 @@

Method Details

"deploymentId": "A String", # The agent's deployment ID. Only applicable to automated agents. "displayName": "A String", # The agent's name. "dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call. + "entrySubagentDisplayName": "A String", # The entry subagent's display name. "location": "A String", # The agent's location. "team": "A String", # A user-specified string representing the agent's team. Deprecated in favor of the `teams` field. "teams": [ # User-specified strings representing the agent's teams. @@ -264,6 +267,7 @@

Method Details

"deploymentId": "A String", # The agent's deployment ID. Only applicable to automated agents. "displayName": "A String", # The agent's name. "dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call. + "entrySubagentDisplayName": "A String", # The entry subagent's display name. "location": "A String", # The agent's location. "team": "A String", # A user-specified string representing the agent's team. Deprecated in favor of the `teams` field. "teams": [ # User-specified strings representing the agent's teams. @@ -301,6 +305,7 @@

Method Details

"deploymentId": "A String", # The agent's deployment ID. Only applicable to automated agents. "displayName": "A String", # The agent's name. "dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call. + "entrySubagentDisplayName": "A String", # The entry subagent's display name. "location": "A String", # The agent's location. "team": "A String", # A user-specified string representing the agent's team. Deprecated in favor of the `teams` field. "teams": [ # User-specified strings representing the agent's teams. @@ -343,6 +348,7 @@

Method Details

"deploymentId": "A String", # The agent's deployment ID. Only applicable to automated agents. "displayName": "A String", # The agent's name. "dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call. + "entrySubagentDisplayName": "A String", # The entry subagent's display name. "location": "A String", # The agent's location. "team": "A String", # A user-specified string representing the agent's team. Deprecated in favor of the `teams` field. "teams": [ # User-specified strings representing the agent's teams. @@ -403,6 +409,7 @@

Method Details

"deploymentId": "A String", # The agent's deployment ID. Only applicable to automated agents. "displayName": "A String", # The agent's name. "dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call. + "entrySubagentDisplayName": "A String", # The entry subagent's display name. "location": "A String", # The agent's location. "team": "A String", # A user-specified string representing the agent's team. Deprecated in favor of the `teams` field. "teams": [ # User-specified strings representing the agent's teams. diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.html b/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.html index 4119760abb..5607ed894a 100644 --- a/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.html +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.html @@ -593,6 +593,7 @@

Method Details

"deploymentId": "A String", # The agent's deployment ID. Only applicable to automated agents. "displayName": "A String", # The agent's name. "dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call. + "entrySubagentDisplayName": "A String", # The entry subagent's display name. "location": "A String", # The agent's location. "team": "A String", # A user-specified string representing the agent's team. Deprecated in favor of the `teams` field. "teams": [ # User-specified strings representing the agent's teams. @@ -1030,6 +1031,7 @@

Method Details

"deploymentId": "A String", # The agent's deployment ID. Only applicable to automated agents. "displayName": "A String", # The agent's name. "dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call. + "entrySubagentDisplayName": "A String", # The entry subagent's display name. "location": "A String", # The agent's location. "team": "A String", # A user-specified string representing the agent's team. Deprecated in favor of the `teams` field. "teams": [ # User-specified strings representing the agent's teams. @@ -1525,6 +1527,7 @@

Method Details

"deploymentId": "A String", # The agent's deployment ID. Only applicable to automated agents. "displayName": "A String", # The agent's name. "dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call. + "entrySubagentDisplayName": "A String", # The entry subagent's display name. "location": "A String", # The agent's location. "team": "A String", # A user-specified string representing the agent's team. Deprecated in favor of the `teams` field. "teams": [ # User-specified strings representing the agent's teams. @@ -2048,6 +2051,7 @@

Method Details

"deploymentId": "A String", # The agent's deployment ID. Only applicable to automated agents. "displayName": "A String", # The agent's name. "dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call. + "entrySubagentDisplayName": "A String", # The entry subagent's display name. "location": "A String", # The agent's location. "team": "A String", # A user-specified string representing the agent's team. Deprecated in favor of the `teams` field. "teams": [ # User-specified strings representing the agent's teams. @@ -2503,6 +2507,7 @@

Method Details

"deploymentId": "A String", # The agent's deployment ID. Only applicable to automated agents. "displayName": "A String", # The agent's name. "dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call. + "entrySubagentDisplayName": "A String", # The entry subagent's display name. "location": "A String", # The agent's location. "team": "A String", # A user-specified string representing the agent's team. Deprecated in favor of the `teams` field. "teams": [ # User-specified strings representing the agent's teams. @@ -2942,6 +2947,7 @@

Method Details

"deploymentId": "A String", # The agent's deployment ID. Only applicable to automated agents. "displayName": "A String", # The agent's name. "dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call. + "entrySubagentDisplayName": "A String", # The entry subagent's display name. "location": "A String", # The agent's location. "team": "A String", # A user-specified string representing the agent's team. Deprecated in favor of the `teams` field. "teams": [ # User-specified strings representing the agent's teams. @@ -3438,6 +3444,7 @@

Method Details

"deploymentId": "A String", # The agent's deployment ID. Only applicable to automated agents. "displayName": "A String", # The agent's name. "dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call. + "entrySubagentDisplayName": "A String", # The entry subagent's display name. "location": "A String", # The agent's location. "team": "A String", # A user-specified string representing the agent's team. Deprecated in favor of the `teams` field. "teams": [ # User-specified strings representing the agent's teams. diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.dashboards.charts.html b/docs/dyn/contactcenterinsights_v1.projects.locations.dashboards.charts.html index b212498bba..881f39964f 100644 --- a/docs/dyn/contactcenterinsights_v1.projects.locations.dashboards.charts.html +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.dashboards.charts.html @@ -108,6 +108,11 @@

Method Details

The object takes the form of: { # Configurable dashboard's widget that displays data as a chart. + "action": { # The action to be taken when the chart is clicked. # Optional action to be taken when the chart is clicked. + "redirectAction": { # The redirect action to be taken when the chart is clicked. # Redirect action. + "relativePath": "A String", # The relative path to redirect to. + }, + }, "chartType": "A String", # Output only. Chart type. "chartVisualizationType": "A String", # Chart visualization type. "createTime": "A String", # Output only. Chart create time. @@ -189,6 +194,11 @@

Method Details

An object of the form: { # Configurable dashboard's widget that displays data as a chart. + "action": { # The action to be taken when the chart is clicked. # Optional action to be taken when the chart is clicked. + "redirectAction": { # The redirect action to be taken when the chart is clicked. # Redirect action. + "relativePath": "A String", # The relative path to redirect to. + }, + }, "chartType": "A String", # Output only. Chart type. "chartVisualizationType": "A String", # Chart visualization type. "createTime": "A String", # Output only. Chart create time. @@ -294,6 +304,11 @@

Method Details

An object of the form: { # Configurable dashboard's widget that displays data as a chart. + "action": { # The action to be taken when the chart is clicked. # Optional action to be taken when the chart is clicked. + "redirectAction": { # The redirect action to be taken when the chart is clicked. # Redirect action. + "relativePath": "A String", # The relative path to redirect to. + }, + }, "chartType": "A String", # Output only. Chart type. "chartVisualizationType": "A String", # Chart visualization type. "createTime": "A String", # Output only. Chart create time. @@ -383,6 +398,11 @@

Method Details

{ # The response of listing charts. "charts": [ # The charts under the parent. { # Configurable dashboard's widget that displays data as a chart. + "action": { # The action to be taken when the chart is clicked. # Optional action to be taken when the chart is clicked. + "redirectAction": { # The redirect action to be taken when the chart is clicked. # Redirect action. + "relativePath": "A String", # The relative path to redirect to. + }, + }, "chartType": "A String", # Output only. Chart type. "chartVisualizationType": "A String", # Chart visualization type. "createTime": "A String", # Output only. Chart create time. @@ -468,6 +488,11 @@

Method Details

The object takes the form of: { # Configurable dashboard's widget that displays data as a chart. + "action": { # The action to be taken when the chart is clicked. # Optional action to be taken when the chart is clicked. + "redirectAction": { # The redirect action to be taken when the chart is clicked. # Redirect action. + "relativePath": "A String", # The relative path to redirect to. + }, + }, "chartType": "A String", # Output only. Chart type. "chartVisualizationType": "A String", # Chart visualization type. "createTime": "A String", # Output only. Chart create time. @@ -549,6 +574,11 @@

Method Details

An object of the form: { # Configurable dashboard's widget that displays data as a chart. + "action": { # The action to be taken when the chart is clicked. # Optional action to be taken when the chart is clicked. + "redirectAction": { # The redirect action to be taken when the chart is clicked. # Redirect action. + "relativePath": "A String", # The relative path to redirect to. + }, + }, "chartType": "A String", # Output only. Chart type. "chartVisualizationType": "A String", # Chart visualization type. "createTime": "A String", # Output only. Chart create time. diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.dashboards.html b/docs/dyn/contactcenterinsights_v1.projects.locations.dashboards.html index 99390523df..1197ff7ab9 100644 --- a/docs/dyn/contactcenterinsights_v1.projects.locations.dashboards.html +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.dashboards.html @@ -151,6 +151,11 @@

Method Details

"widgets": [ # Widgets in the Container. { # Represents a dashboard element, could be a nested Container or Chart. "chart": { # Configurable dashboard's widget that displays data as a chart. # A chart widget. + "action": { # The action to be taken when the chart is clicked. # Optional action to be taken when the chart is clicked. + "redirectAction": { # The redirect action to be taken when the chart is clicked. # Redirect action. + "relativePath": "A String", # The relative path to redirect to. + }, + }, "chartType": "A String", # Output only. Chart type. "chartVisualizationType": "A String", # Chart visualization type. "createTime": "A String", # Output only. Chart create time. @@ -276,6 +281,11 @@

Method Details

"widgets": [ # Widgets in the Container. { # Represents a dashboard element, could be a nested Container or Chart. "chart": { # Configurable dashboard's widget that displays data as a chart. # A chart widget. + "action": { # The action to be taken when the chart is clicked. # Optional action to be taken when the chart is clicked. + "redirectAction": { # The redirect action to be taken when the chart is clicked. # Redirect action. + "relativePath": "A String", # The relative path to redirect to. + }, + }, "chartType": "A String", # Output only. Chart type. "chartVisualizationType": "A String", # Chart visualization type. "createTime": "A String", # Output only. Chart create time. @@ -425,6 +435,11 @@

Method Details

"widgets": [ # Widgets in the Container. { # Represents a dashboard element, could be a nested Container or Chart. "chart": { # Configurable dashboard's widget that displays data as a chart. # A chart widget. + "action": { # The action to be taken when the chart is clicked. # Optional action to be taken when the chart is clicked. + "redirectAction": { # The redirect action to be taken when the chart is clicked. # Redirect action. + "relativePath": "A String", # The relative path to redirect to. + }, + }, "chartType": "A String", # Output only. Chart type. "chartVisualizationType": "A String", # Chart visualization type. "createTime": "A String", # Output only. Chart create time. @@ -562,6 +577,11 @@

Method Details

"widgets": [ # Widgets in the Container. { # Represents a dashboard element, could be a nested Container or Chart. "chart": { # Configurable dashboard's widget that displays data as a chart. # A chart widget. + "action": { # The action to be taken when the chart is clicked. # Optional action to be taken when the chart is clicked. + "redirectAction": { # The redirect action to be taken when the chart is clicked. # Redirect action. + "relativePath": "A String", # The relative path to redirect to. + }, + }, "chartType": "A String", # Output only. Chart type. "chartVisualizationType": "A String", # Chart visualization type. "createTime": "A String", # Output only. Chart create time. @@ -705,6 +725,11 @@

Method Details

"widgets": [ # Widgets in the Container. { # Represents a dashboard element, could be a nested Container or Chart. "chart": { # Configurable dashboard's widget that displays data as a chart. # A chart widget. + "action": { # The action to be taken when the chart is clicked. # Optional action to be taken when the chart is clicked. + "redirectAction": { # The redirect action to be taken when the chart is clicked. # Redirect action. + "relativePath": "A String", # The relative path to redirect to. + }, + }, "chartType": "A String", # Output only. Chart type. "chartVisualizationType": "A String", # Chart visualization type. "createTime": "A String", # Output only. Chart create time. @@ -830,6 +855,11 @@

Method Details

"widgets": [ # Widgets in the Container. { # Represents a dashboard element, could be a nested Container or Chart. "chart": { # Configurable dashboard's widget that displays data as a chart. # A chart widget. + "action": { # The action to be taken when the chart is clicked. # Optional action to be taken when the chart is clicked. + "redirectAction": { # The redirect action to be taken when the chart is clicked. # Redirect action. + "relativePath": "A String", # The relative path to redirect to. + }, + }, "chartType": "A String", # Output only. Chart type. "chartVisualizationType": "A String", # Chart visualization type. "createTime": "A String", # Output only. Chart create time. diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.datasets.conversations.html b/docs/dyn/contactcenterinsights_v1.projects.locations.datasets.conversations.html index 547fa34a98..1374df529b 100644 --- a/docs/dyn/contactcenterinsights_v1.projects.locations.datasets.conversations.html +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.datasets.conversations.html @@ -554,6 +554,7 @@

Method Details

"deploymentId": "A String", # The agent's deployment ID. Only applicable to automated agents. "displayName": "A String", # The agent's name. "dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call. + "entrySubagentDisplayName": "A String", # The entry subagent's display name. "location": "A String", # The agent's location. "team": "A String", # A user-specified string representing the agent's team. Deprecated in favor of the `teams` field. "teams": [ # User-specified strings representing the agent's teams. @@ -1077,6 +1078,7 @@

Method Details

"deploymentId": "A String", # The agent's deployment ID. Only applicable to automated agents. "displayName": "A String", # The agent's name. "dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call. + "entrySubagentDisplayName": "A String", # The entry subagent's display name. "location": "A String", # The agent's location. "team": "A String", # A user-specified string representing the agent's team. Deprecated in favor of the `teams` field. "teams": [ # User-specified strings representing the agent's teams. diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.html b/docs/dyn/contactcenterinsights_v1.projects.locations.html index 3ea1c1b452..62337954e9 100644 --- a/docs/dyn/contactcenterinsights_v1.projects.locations.html +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.html @@ -1019,6 +1019,7 @@

Method Details

"deploymentId": "A String", # The agent's deployment ID. Only applicable to automated agents. "displayName": "A String", # The agent's name. "dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call. + "entrySubagentDisplayName": "A String", # The entry subagent's display name. "location": "A String", # The agent's location. "team": "A String", # A user-specified string representing the agent's team. Deprecated in favor of the `teams` field. "teams": [ # User-specified strings representing the agent's teams. diff --git a/docs/dyn/container_v1.projects.locations.clusters.html b/docs/dyn/container_v1.projects.locations.clusters.html index 33bb3d6fc6..a5fd08ce33 100644 --- a/docs/dyn/container_v1.projects.locations.clusters.html +++ b/docs/dyn/container_v1.projects.locations.clusters.html @@ -1574,6 +1574,7 @@

Method Details

}, "name": "A String", # The name of the node pool. "networkConfig": { # Parameters for node pool-level network config. # Networking configuration for this NodePool. If specified, it overrides the cluster-level defaults. + "acceleratorNetworkProfile": "A String", # Immutable. The accelerator network profile for the node pool. For now the only valid value is "auto". If specified, the network configuration of the nodes in this node pool will be managed by this profile for the supported machine types, zone, etc. "additionalNodeNetworkConfigs": [ # We specify the additional node networks for this node pool using this list. Each node network corresponds to an additional interface { # AdditionalNodeNetworkConfig is the configuration for additional node networks within the NodeNetworkConfig message "network": "A String", # Name of the VPC where the additional interface belongs @@ -3256,6 +3257,7 @@

Method Details

}, "name": "A String", # The name of the node pool. "networkConfig": { # Parameters for node pool-level network config. # Networking configuration for this NodePool. If specified, it overrides the cluster-level defaults. + "acceleratorNetworkProfile": "A String", # Immutable. The accelerator network profile for the node pool. For now the only valid value is "auto". If specified, the network configuration of the nodes in this node pool will be managed by this profile for the supported machine types, zone, etc. "additionalNodeNetworkConfigs": [ # We specify the additional node networks for this node pool using this list. Each node network corresponds to an additional interface { # AdditionalNodeNetworkConfig is the configuration for additional node networks within the NodeNetworkConfig message "network": "A String", # Name of the VPC where the additional interface belongs @@ -4802,6 +4804,7 @@

Method Details

}, "name": "A String", # The name of the node pool. "networkConfig": { # Parameters for node pool-level network config. # Networking configuration for this NodePool. If specified, it overrides the cluster-level defaults. + "acceleratorNetworkProfile": "A String", # Immutable. The accelerator network profile for the node pool. For now the only valid value is "auto". If specified, the network configuration of the nodes in this node pool will be managed by this profile for the supported machine types, zone, etc. "additionalNodeNetworkConfigs": [ # We specify the additional node networks for this node pool using this list. Each node network corresponds to an additional interface { # AdditionalNodeNetworkConfig is the configuration for additional node networks within the NodeNetworkConfig message "network": "A String", # Name of the VPC where the additional interface belongs diff --git a/docs/dyn/container_v1.projects.locations.clusters.nodePools.html b/docs/dyn/container_v1.projects.locations.clusters.nodePools.html index f8f08ecdac..ba9263551e 100644 --- a/docs/dyn/container_v1.projects.locations.clusters.nodePools.html +++ b/docs/dyn/container_v1.projects.locations.clusters.nodePools.html @@ -487,6 +487,7 @@

Method Details

}, "name": "A String", # The name of the node pool. "networkConfig": { # Parameters for node pool-level network config. # Networking configuration for this NodePool. If specified, it overrides the cluster-level defaults. + "acceleratorNetworkProfile": "A String", # Immutable. The accelerator network profile for the node pool. For now the only valid value is "auto". If specified, the network configuration of the nodes in this node pool will be managed by this profile for the supported machine types, zone, etc. "additionalNodeNetworkConfigs": [ # We specify the additional node networks for this node pool using this list. Each node network corresponds to an additional interface { # AdditionalNodeNetworkConfig is the configuration for additional node networks within the NodeNetworkConfig message "network": "A String", # Name of the VPC where the additional interface belongs @@ -1095,6 +1096,7 @@

Method Details

}, "name": "A String", # The name of the node pool. "networkConfig": { # Parameters for node pool-level network config. # Networking configuration for this NodePool. If specified, it overrides the cluster-level defaults. + "acceleratorNetworkProfile": "A String", # Immutable. The accelerator network profile for the node pool. For now the only valid value is "auto". If specified, the network configuration of the nodes in this node pool will be managed by this profile for the supported machine types, zone, etc. "additionalNodeNetworkConfigs": [ # We specify the additional node networks for this node pool using this list. Each node network corresponds to an additional interface { # AdditionalNodeNetworkConfig is the configuration for additional node networks within the NodeNetworkConfig message "network": "A String", # Name of the VPC where the additional interface belongs @@ -1530,6 +1532,7 @@

Method Details

}, "name": "A String", # The name of the node pool. "networkConfig": { # Parameters for node pool-level network config. # Networking configuration for this NodePool. If specified, it overrides the cluster-level defaults. + "acceleratorNetworkProfile": "A String", # Immutable. The accelerator network profile for the node pool. For now the only valid value is "auto". If specified, the network configuration of the nodes in this node pool will be managed by this profile for the supported machine types, zone, etc. "additionalNodeNetworkConfigs": [ # We specify the additional node networks for this node pool using this list. Each node network corresponds to an additional interface { # AdditionalNodeNetworkConfig is the configuration for additional node networks within the NodeNetworkConfig message "network": "A String", # Name of the VPC where the additional interface belongs @@ -2159,6 +2162,7 @@

Method Details

"respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion. }, "nodeNetworkConfig": { # Parameters for node pool-level network config. # Node network config. + "acceleratorNetworkProfile": "A String", # Immutable. The accelerator network profile for the node pool. For now the only valid value is "auto". If specified, the network configuration of the nodes in this node pool will be managed by this profile for the supported machine types, zone, etc. "additionalNodeNetworkConfigs": [ # We specify the additional node networks for this node pool using this list. Each node network corresponds to an additional interface { # AdditionalNodeNetworkConfig is the configuration for additional node networks within the NodeNetworkConfig message "network": "A String", # Name of the VPC where the additional interface belongs diff --git a/docs/dyn/container_v1.projects.zones.clusters.html b/docs/dyn/container_v1.projects.zones.clusters.html index f1d0e3a17e..a5aa5b54a8 100644 --- a/docs/dyn/container_v1.projects.zones.clusters.html +++ b/docs/dyn/container_v1.projects.zones.clusters.html @@ -1676,6 +1676,7 @@

Method Details

}, "name": "A String", # The name of the node pool. "networkConfig": { # Parameters for node pool-level network config. # Networking configuration for this NodePool. If specified, it overrides the cluster-level defaults. + "acceleratorNetworkProfile": "A String", # Immutable. The accelerator network profile for the node pool. For now the only valid value is "auto". If specified, the network configuration of the nodes in this node pool will be managed by this profile for the supported machine types, zone, etc. "additionalNodeNetworkConfigs": [ # We specify the additional node networks for this node pool using this list. Each node network corresponds to an additional interface { # AdditionalNodeNetworkConfig is the configuration for additional node networks within the NodeNetworkConfig message "network": "A String", # Name of the VPC where the additional interface belongs @@ -3358,6 +3359,7 @@

Method Details

}, "name": "A String", # The name of the node pool. "networkConfig": { # Parameters for node pool-level network config. # Networking configuration for this NodePool. If specified, it overrides the cluster-level defaults. + "acceleratorNetworkProfile": "A String", # Immutable. The accelerator network profile for the node pool. For now the only valid value is "auto". If specified, the network configuration of the nodes in this node pool will be managed by this profile for the supported machine types, zone, etc. "additionalNodeNetworkConfigs": [ # We specify the additional node networks for this node pool using this list. Each node network corresponds to an additional interface { # AdditionalNodeNetworkConfig is the configuration for additional node networks within the NodeNetworkConfig message "network": "A String", # Name of the VPC where the additional interface belongs @@ -4948,6 +4950,7 @@

Method Details

}, "name": "A String", # The name of the node pool. "networkConfig": { # Parameters for node pool-level network config. # Networking configuration for this NodePool. If specified, it overrides the cluster-level defaults. + "acceleratorNetworkProfile": "A String", # Immutable. The accelerator network profile for the node pool. For now the only valid value is "auto". If specified, the network configuration of the nodes in this node pool will be managed by this profile for the supported machine types, zone, etc. "additionalNodeNetworkConfigs": [ # We specify the additional node networks for this node pool using this list. Each node network corresponds to an additional interface { # AdditionalNodeNetworkConfig is the configuration for additional node networks within the NodeNetworkConfig message "network": "A String", # Name of the VPC where the additional interface belongs diff --git a/docs/dyn/container_v1.projects.zones.clusters.nodePools.html b/docs/dyn/container_v1.projects.zones.clusters.nodePools.html index f07110ee7a..d6bdfc5370 100644 --- a/docs/dyn/container_v1.projects.zones.clusters.nodePools.html +++ b/docs/dyn/container_v1.projects.zones.clusters.nodePools.html @@ -552,6 +552,7 @@

Method Details

}, "name": "A String", # The name of the node pool. "networkConfig": { # Parameters for node pool-level network config. # Networking configuration for this NodePool. If specified, it overrides the cluster-level defaults. + "acceleratorNetworkProfile": "A String", # Immutable. The accelerator network profile for the node pool. For now the only valid value is "auto". If specified, the network configuration of the nodes in this node pool will be managed by this profile for the supported machine types, zone, etc. "additionalNodeNetworkConfigs": [ # We specify the additional node networks for this node pool using this list. Each node network corresponds to an additional interface { # AdditionalNodeNetworkConfig is the configuration for additional node networks within the NodeNetworkConfig message "network": "A String", # Name of the VPC where the additional interface belongs @@ -1160,6 +1161,7 @@

Method Details

}, "name": "A String", # The name of the node pool. "networkConfig": { # Parameters for node pool-level network config. # Networking configuration for this NodePool. If specified, it overrides the cluster-level defaults. + "acceleratorNetworkProfile": "A String", # Immutable. The accelerator network profile for the node pool. For now the only valid value is "auto". If specified, the network configuration of the nodes in this node pool will be managed by this profile for the supported machine types, zone, etc. "additionalNodeNetworkConfigs": [ # We specify the additional node networks for this node pool using this list. Each node network corresponds to an additional interface { # AdditionalNodeNetworkConfig is the configuration for additional node networks within the NodeNetworkConfig message "network": "A String", # Name of the VPC where the additional interface belongs @@ -1595,6 +1597,7 @@

Method Details

}, "name": "A String", # The name of the node pool. "networkConfig": { # Parameters for node pool-level network config. # Networking configuration for this NodePool. If specified, it overrides the cluster-level defaults. + "acceleratorNetworkProfile": "A String", # Immutable. The accelerator network profile for the node pool. For now the only valid value is "auto". If specified, the network configuration of the nodes in this node pool will be managed by this profile for the supported machine types, zone, etc. "additionalNodeNetworkConfigs": [ # We specify the additional node networks for this node pool using this list. Each node network corresponds to an additional interface { # AdditionalNodeNetworkConfig is the configuration for additional node networks within the NodeNetworkConfig message "network": "A String", # Name of the VPC where the additional interface belongs @@ -2149,6 +2152,7 @@

Method Details

"respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion. }, "nodeNetworkConfig": { # Parameters for node pool-level network config. # Node network config. + "acceleratorNetworkProfile": "A String", # Immutable. The accelerator network profile for the node pool. For now the only valid value is "auto". If specified, the network configuration of the nodes in this node pool will be managed by this profile for the supported machine types, zone, etc. "additionalNodeNetworkConfigs": [ # We specify the additional node networks for this node pool using this list. Each node network corresponds to an additional interface { # AdditionalNodeNetworkConfig is the configuration for additional node networks within the NodeNetworkConfig message "network": "A String", # Name of the VPC where the additional interface belongs diff --git a/docs/dyn/containeranalysis_v1.projects.locations.notes.occurrences.html b/docs/dyn/containeranalysis_v1.projects.locations.notes.occurrences.html index b923f21ec9..09779ff22e 100644 --- a/docs/dyn/containeranalysis_v1.projects.locations.notes.occurrences.html +++ b/docs/dyn/containeranalysis_v1.projects.locations.notes.occurrences.html @@ -110,6 +110,7 @@

Method Details

"nextPageToken": "A String", # Token to provide to skip to a particular spot in the list. "occurrences": [ # The occurrences attached to the specified note. { # An instance of an analysis type that has been found on a resource. + "advisoryPublishTime": "A String", # The time this advisory was published by the source. "attestation": { # Occurrence that represents a single "attestation". The authenticity of an attestation can be verified using the attached signature. If the verifier trusts the public key of the signer, then verifying the signature is sufficient to establish trust. In this circumstance, the authority to which this attestation is attached is primarily useful for lookup (how to find this attestation if you already know the authority and artifact to be verified) and intent (for which authority this attestation was intended to sign. # Describes an attestation of an artifact. "jwts": [ # One or more JWTs encoding a self-contained attestation. Each JWT encodes the payload that it verifies within the JWT itself. Verifier implementation SHOULD ignore the `serialized_payload` field when verifying these JWTs. If only JWTs are present on this AttestationOccurrence, then the `serialized_payload` SHOULD be left empty. Each JWT SHOULD encode a claim specific to the `resource_uri` of this Occurrence, but this is not validated by Grafeas metadata API implementations. The JWT itself is opaque to Grafeas. { diff --git a/docs/dyn/containeranalysis_v1.projects.locations.occurrences.html b/docs/dyn/containeranalysis_v1.projects.locations.occurrences.html index d72df17cf4..3469588f1b 100644 --- a/docs/dyn/containeranalysis_v1.projects.locations.occurrences.html +++ b/docs/dyn/containeranalysis_v1.projects.locations.occurrences.html @@ -126,6 +126,7 @@

Method Details

{ # Request to create occurrences in batch. "occurrences": [ # Required. The occurrences to create. Max allowed length is 1000. { # An instance of an analysis type that has been found on a resource. + "advisoryPublishTime": "A String", # The time this advisory was published by the source. "attestation": { # Occurrence that represents a single "attestation". The authenticity of an attestation can be verified using the attached signature. If the verifier trusts the public key of the signer, then verifying the signature is sufficient to establish trust. In this circumstance, the authority to which this attestation is attached is primarily useful for lookup (how to find this attestation if you already know the authority and artifact to be verified) and intent (for which authority this attestation was intended to sign. # Describes an attestation of an artifact. "jwts": [ # One or more JWTs encoding a self-contained attestation. Each JWT encodes the payload that it verifies within the JWT itself. Verifier implementation SHOULD ignore the `serialized_payload` field when verifying these JWTs. If only JWTs are present on this AttestationOccurrence, then the `serialized_payload` SHOULD be left empty. Each JWT SHOULD encode a claim specific to the `resource_uri` of this Occurrence, but this is not validated by Grafeas metadata API implementations. The JWT itself is opaque to Grafeas. { @@ -1017,6 +1018,7 @@

Method Details

{ # Response for creating occurrences in batch. "occurrences": [ # The occurrences that were created. { # An instance of an analysis type that has been found on a resource. + "advisoryPublishTime": "A String", # The time this advisory was published by the source. "attestation": { # Occurrence that represents a single "attestation". The authenticity of an attestation can be verified using the attached signature. If the verifier trusts the public key of the signer, then verifying the signature is sufficient to establish trust. In this circumstance, the authority to which this attestation is attached is primarily useful for lookup (how to find this attestation if you already know the authority and artifact to be verified) and intent (for which authority this attestation was intended to sign. # Describes an attestation of an artifact. "jwts": [ # One or more JWTs encoding a self-contained attestation. Each JWT encodes the payload that it verifies within the JWT itself. Verifier implementation SHOULD ignore the `serialized_payload` field when verifying these JWTs. If only JWTs are present on this AttestationOccurrence, then the `serialized_payload` SHOULD be left empty. Each JWT SHOULD encode a claim specific to the `resource_uri` of this Occurrence, but this is not validated by Grafeas metadata API implementations. The JWT itself is opaque to Grafeas. { @@ -1913,6 +1915,7 @@

Method Details

The object takes the form of: { # An instance of an analysis type that has been found on a resource. + "advisoryPublishTime": "A String", # The time this advisory was published by the source. "attestation": { # Occurrence that represents a single "attestation". The authenticity of an attestation can be verified using the attached signature. If the verifier trusts the public key of the signer, then verifying the signature is sufficient to establish trust. In this circumstance, the authority to which this attestation is attached is primarily useful for lookup (how to find this attestation if you already know the authority and artifact to be verified) and intent (for which authority this attestation was intended to sign. # Describes an attestation of an artifact. "jwts": [ # One or more JWTs encoding a self-contained attestation. Each JWT encodes the payload that it verifies within the JWT itself. Verifier implementation SHOULD ignore the `serialized_payload` field when verifying these JWTs. If only JWTs are present on this AttestationOccurrence, then the `serialized_payload` SHOULD be left empty. Each JWT SHOULD encode a claim specific to the `resource_uri` of this Occurrence, but this is not validated by Grafeas metadata API implementations. The JWT itself is opaque to Grafeas. { @@ -2800,6 +2803,7 @@

Method Details

An object of the form: { # An instance of an analysis type that has been found on a resource. + "advisoryPublishTime": "A String", # The time this advisory was published by the source. "attestation": { # Occurrence that represents a single "attestation". The authenticity of an attestation can be verified using the attached signature. If the verifier trusts the public key of the signer, then verifying the signature is sufficient to establish trust. In this circumstance, the authority to which this attestation is attached is primarily useful for lookup (how to find this attestation if you already know the authority and artifact to be verified) and intent (for which authority this attestation was intended to sign. # Describes an attestation of an artifact. "jwts": [ # One or more JWTs encoding a self-contained attestation. Each JWT encodes the payload that it verifies within the JWT itself. Verifier implementation SHOULD ignore the `serialized_payload` field when verifying these JWTs. If only JWTs are present on this AttestationOccurrence, then the `serialized_payload` SHOULD be left empty. Each JWT SHOULD encode a claim specific to the `resource_uri` of this Occurrence, but this is not validated by Grafeas metadata API implementations. The JWT itself is opaque to Grafeas. { @@ -3712,6 +3716,7 @@

Method Details

An object of the form: { # An instance of an analysis type that has been found on a resource. + "advisoryPublishTime": "A String", # The time this advisory was published by the source. "attestation": { # Occurrence that represents a single "attestation". The authenticity of an attestation can be verified using the attached signature. If the verifier trusts the public key of the signer, then verifying the signature is sufficient to establish trust. In this circumstance, the authority to which this attestation is attached is primarily useful for lookup (how to find this attestation if you already know the authority and artifact to be verified) and intent (for which authority this attestation was intended to sign. # Describes an attestation of an artifact. "jwts": [ # One or more JWTs encoding a self-contained attestation. Each JWT encodes the payload that it verifies within the JWT itself. Verifier implementation SHOULD ignore the `serialized_payload` field when verifying these JWTs. If only JWTs are present on this AttestationOccurrence, then the `serialized_payload` SHOULD be left empty. Each JWT SHOULD encode a claim specific to the `resource_uri` of this Occurrence, but this is not validated by Grafeas metadata API implementations. The JWT itself is opaque to Grafeas. { @@ -4993,6 +4998,7 @@

Method Details

"nextPageToken": "A String", # The next pagination token in the list response. It should be used as `page_token` for the following request. An empty value means no more results. "occurrences": [ # The occurrences requested. { # An instance of an analysis type that has been found on a resource. + "advisoryPublishTime": "A String", # The time this advisory was published by the source. "attestation": { # Occurrence that represents a single "attestation". The authenticity of an attestation can be verified using the attached signature. If the verifier trusts the public key of the signer, then verifying the signature is sufficient to establish trust. In this circumstance, the authority to which this attestation is attached is primarily useful for lookup (how to find this attestation if you already know the authority and artifact to be verified) and intent (for which authority this attestation was intended to sign. # Describes an attestation of an artifact. "jwts": [ # One or more JWTs encoding a self-contained attestation. Each JWT encodes the payload that it verifies within the JWT itself. Verifier implementation SHOULD ignore the `serialized_payload` field when verifying these JWTs. If only JWTs are present on this AttestationOccurrence, then the `serialized_payload` SHOULD be left empty. Each JWT SHOULD encode a claim specific to the `resource_uri` of this Occurrence, but this is not validated by Grafeas metadata API implementations. The JWT itself is opaque to Grafeas. { @@ -5901,6 +5907,7 @@

Method Details

The object takes the form of: { # An instance of an analysis type that has been found on a resource. + "advisoryPublishTime": "A String", # The time this advisory was published by the source. "attestation": { # Occurrence that represents a single "attestation". The authenticity of an attestation can be verified using the attached signature. If the verifier trusts the public key of the signer, then verifying the signature is sufficient to establish trust. In this circumstance, the authority to which this attestation is attached is primarily useful for lookup (how to find this attestation if you already know the authority and artifact to be verified) and intent (for which authority this attestation was intended to sign. # Describes an attestation of an artifact. "jwts": [ # One or more JWTs encoding a self-contained attestation. Each JWT encodes the payload that it verifies within the JWT itself. Verifier implementation SHOULD ignore the `serialized_payload` field when verifying these JWTs. If only JWTs are present on this AttestationOccurrence, then the `serialized_payload` SHOULD be left empty. Each JWT SHOULD encode a claim specific to the `resource_uri` of this Occurrence, but this is not validated by Grafeas metadata API implementations. The JWT itself is opaque to Grafeas. { @@ -6789,6 +6796,7 @@

Method Details

An object of the form: { # An instance of an analysis type that has been found on a resource. + "advisoryPublishTime": "A String", # The time this advisory was published by the source. "attestation": { # Occurrence that represents a single "attestation". The authenticity of an attestation can be verified using the attached signature. If the verifier trusts the public key of the signer, then verifying the signature is sufficient to establish trust. In this circumstance, the authority to which this attestation is attached is primarily useful for lookup (how to find this attestation if you already know the authority and artifact to be verified) and intent (for which authority this attestation was intended to sign. # Describes an attestation of an artifact. "jwts": [ # One or more JWTs encoding a self-contained attestation. Each JWT encodes the payload that it verifies within the JWT itself. Verifier implementation SHOULD ignore the `serialized_payload` field when verifying these JWTs. If only JWTs are present on this AttestationOccurrence, then the `serialized_payload` SHOULD be left empty. Each JWT SHOULD encode a claim specific to the `resource_uri` of this Occurrence, but this is not validated by Grafeas metadata API implementations. The JWT itself is opaque to Grafeas. { diff --git a/docs/dyn/containeranalysis_v1.projects.notes.occurrences.html b/docs/dyn/containeranalysis_v1.projects.notes.occurrences.html index f37f44662e..271578f725 100644 --- a/docs/dyn/containeranalysis_v1.projects.notes.occurrences.html +++ b/docs/dyn/containeranalysis_v1.projects.notes.occurrences.html @@ -110,6 +110,7 @@

Method Details

"nextPageToken": "A String", # Token to provide to skip to a particular spot in the list. "occurrences": [ # The occurrences attached to the specified note. { # An instance of an analysis type that has been found on a resource. + "advisoryPublishTime": "A String", # The time this advisory was published by the source. "attestation": { # Occurrence that represents a single "attestation". The authenticity of an attestation can be verified using the attached signature. If the verifier trusts the public key of the signer, then verifying the signature is sufficient to establish trust. In this circumstance, the authority to which this attestation is attached is primarily useful for lookup (how to find this attestation if you already know the authority and artifact to be verified) and intent (for which authority this attestation was intended to sign. # Describes an attestation of an artifact. "jwts": [ # One or more JWTs encoding a self-contained attestation. Each JWT encodes the payload that it verifies within the JWT itself. Verifier implementation SHOULD ignore the `serialized_payload` field when verifying these JWTs. If only JWTs are present on this AttestationOccurrence, then the `serialized_payload` SHOULD be left empty. Each JWT SHOULD encode a claim specific to the `resource_uri` of this Occurrence, but this is not validated by Grafeas metadata API implementations. The JWT itself is opaque to Grafeas. { diff --git a/docs/dyn/containeranalysis_v1.projects.occurrences.html b/docs/dyn/containeranalysis_v1.projects.occurrences.html index 9c239f4eed..f2a037e9a0 100644 --- a/docs/dyn/containeranalysis_v1.projects.occurrences.html +++ b/docs/dyn/containeranalysis_v1.projects.occurrences.html @@ -126,6 +126,7 @@

Method Details

{ # Request to create occurrences in batch. "occurrences": [ # Required. The occurrences to create. Max allowed length is 1000. { # An instance of an analysis type that has been found on a resource. + "advisoryPublishTime": "A String", # The time this advisory was published by the source. "attestation": { # Occurrence that represents a single "attestation". The authenticity of an attestation can be verified using the attached signature. If the verifier trusts the public key of the signer, then verifying the signature is sufficient to establish trust. In this circumstance, the authority to which this attestation is attached is primarily useful for lookup (how to find this attestation if you already know the authority and artifact to be verified) and intent (for which authority this attestation was intended to sign. # Describes an attestation of an artifact. "jwts": [ # One or more JWTs encoding a self-contained attestation. Each JWT encodes the payload that it verifies within the JWT itself. Verifier implementation SHOULD ignore the `serialized_payload` field when verifying these JWTs. If only JWTs are present on this AttestationOccurrence, then the `serialized_payload` SHOULD be left empty. Each JWT SHOULD encode a claim specific to the `resource_uri` of this Occurrence, but this is not validated by Grafeas metadata API implementations. The JWT itself is opaque to Grafeas. { @@ -1017,6 +1018,7 @@

Method Details

{ # Response for creating occurrences in batch. "occurrences": [ # The occurrences that were created. { # An instance of an analysis type that has been found on a resource. + "advisoryPublishTime": "A String", # The time this advisory was published by the source. "attestation": { # Occurrence that represents a single "attestation". The authenticity of an attestation can be verified using the attached signature. If the verifier trusts the public key of the signer, then verifying the signature is sufficient to establish trust. In this circumstance, the authority to which this attestation is attached is primarily useful for lookup (how to find this attestation if you already know the authority and artifact to be verified) and intent (for which authority this attestation was intended to sign. # Describes an attestation of an artifact. "jwts": [ # One or more JWTs encoding a self-contained attestation. Each JWT encodes the payload that it verifies within the JWT itself. Verifier implementation SHOULD ignore the `serialized_payload` field when verifying these JWTs. If only JWTs are present on this AttestationOccurrence, then the `serialized_payload` SHOULD be left empty. Each JWT SHOULD encode a claim specific to the `resource_uri` of this Occurrence, but this is not validated by Grafeas metadata API implementations. The JWT itself is opaque to Grafeas. { @@ -1913,6 +1915,7 @@

Method Details

The object takes the form of: { # An instance of an analysis type that has been found on a resource. + "advisoryPublishTime": "A String", # The time this advisory was published by the source. "attestation": { # Occurrence that represents a single "attestation". The authenticity of an attestation can be verified using the attached signature. If the verifier trusts the public key of the signer, then verifying the signature is sufficient to establish trust. In this circumstance, the authority to which this attestation is attached is primarily useful for lookup (how to find this attestation if you already know the authority and artifact to be verified) and intent (for which authority this attestation was intended to sign. # Describes an attestation of an artifact. "jwts": [ # One or more JWTs encoding a self-contained attestation. Each JWT encodes the payload that it verifies within the JWT itself. Verifier implementation SHOULD ignore the `serialized_payload` field when verifying these JWTs. If only JWTs are present on this AttestationOccurrence, then the `serialized_payload` SHOULD be left empty. Each JWT SHOULD encode a claim specific to the `resource_uri` of this Occurrence, but this is not validated by Grafeas metadata API implementations. The JWT itself is opaque to Grafeas. { @@ -2800,6 +2803,7 @@

Method Details

An object of the form: { # An instance of an analysis type that has been found on a resource. + "advisoryPublishTime": "A String", # The time this advisory was published by the source. "attestation": { # Occurrence that represents a single "attestation". The authenticity of an attestation can be verified using the attached signature. If the verifier trusts the public key of the signer, then verifying the signature is sufficient to establish trust. In this circumstance, the authority to which this attestation is attached is primarily useful for lookup (how to find this attestation if you already know the authority and artifact to be verified) and intent (for which authority this attestation was intended to sign. # Describes an attestation of an artifact. "jwts": [ # One or more JWTs encoding a self-contained attestation. Each JWT encodes the payload that it verifies within the JWT itself. Verifier implementation SHOULD ignore the `serialized_payload` field when verifying these JWTs. If only JWTs are present on this AttestationOccurrence, then the `serialized_payload` SHOULD be left empty. Each JWT SHOULD encode a claim specific to the `resource_uri` of this Occurrence, but this is not validated by Grafeas metadata API implementations. The JWT itself is opaque to Grafeas. { @@ -3712,6 +3716,7 @@

Method Details

An object of the form: { # An instance of an analysis type that has been found on a resource. + "advisoryPublishTime": "A String", # The time this advisory was published by the source. "attestation": { # Occurrence that represents a single "attestation". The authenticity of an attestation can be verified using the attached signature. If the verifier trusts the public key of the signer, then verifying the signature is sufficient to establish trust. In this circumstance, the authority to which this attestation is attached is primarily useful for lookup (how to find this attestation if you already know the authority and artifact to be verified) and intent (for which authority this attestation was intended to sign. # Describes an attestation of an artifact. "jwts": [ # One or more JWTs encoding a self-contained attestation. Each JWT encodes the payload that it verifies within the JWT itself. Verifier implementation SHOULD ignore the `serialized_payload` field when verifying these JWTs. If only JWTs are present on this AttestationOccurrence, then the `serialized_payload` SHOULD be left empty. Each JWT SHOULD encode a claim specific to the `resource_uri` of this Occurrence, but this is not validated by Grafeas metadata API implementations. The JWT itself is opaque to Grafeas. { @@ -4993,6 +4998,7 @@

Method Details

"nextPageToken": "A String", # The next pagination token in the list response. It should be used as `page_token` for the following request. An empty value means no more results. "occurrences": [ # The occurrences requested. { # An instance of an analysis type that has been found on a resource. + "advisoryPublishTime": "A String", # The time this advisory was published by the source. "attestation": { # Occurrence that represents a single "attestation". The authenticity of an attestation can be verified using the attached signature. If the verifier trusts the public key of the signer, then verifying the signature is sufficient to establish trust. In this circumstance, the authority to which this attestation is attached is primarily useful for lookup (how to find this attestation if you already know the authority and artifact to be verified) and intent (for which authority this attestation was intended to sign. # Describes an attestation of an artifact. "jwts": [ # One or more JWTs encoding a self-contained attestation. Each JWT encodes the payload that it verifies within the JWT itself. Verifier implementation SHOULD ignore the `serialized_payload` field when verifying these JWTs. If only JWTs are present on this AttestationOccurrence, then the `serialized_payload` SHOULD be left empty. Each JWT SHOULD encode a claim specific to the `resource_uri` of this Occurrence, but this is not validated by Grafeas metadata API implementations. The JWT itself is opaque to Grafeas. { @@ -5901,6 +5907,7 @@

Method Details

The object takes the form of: { # An instance of an analysis type that has been found on a resource. + "advisoryPublishTime": "A String", # The time this advisory was published by the source. "attestation": { # Occurrence that represents a single "attestation". The authenticity of an attestation can be verified using the attached signature. If the verifier trusts the public key of the signer, then verifying the signature is sufficient to establish trust. In this circumstance, the authority to which this attestation is attached is primarily useful for lookup (how to find this attestation if you already know the authority and artifact to be verified) and intent (for which authority this attestation was intended to sign. # Describes an attestation of an artifact. "jwts": [ # One or more JWTs encoding a self-contained attestation. Each JWT encodes the payload that it verifies within the JWT itself. Verifier implementation SHOULD ignore the `serialized_payload` field when verifying these JWTs. If only JWTs are present on this AttestationOccurrence, then the `serialized_payload` SHOULD be left empty. Each JWT SHOULD encode a claim specific to the `resource_uri` of this Occurrence, but this is not validated by Grafeas metadata API implementations. The JWT itself is opaque to Grafeas. { @@ -6789,6 +6796,7 @@

Method Details

An object of the form: { # An instance of an analysis type that has been found on a resource. + "advisoryPublishTime": "A String", # The time this advisory was published by the source. "attestation": { # Occurrence that represents a single "attestation". The authenticity of an attestation can be verified using the attached signature. If the verifier trusts the public key of the signer, then verifying the signature is sufficient to establish trust. In this circumstance, the authority to which this attestation is attached is primarily useful for lookup (how to find this attestation if you already know the authority and artifact to be verified) and intent (for which authority this attestation was intended to sign. # Describes an attestation of an artifact. "jwts": [ # One or more JWTs encoding a self-contained attestation. Each JWT encodes the payload that it verifies within the JWT itself. Verifier implementation SHOULD ignore the `serialized_payload` field when verifying these JWTs. If only JWTs are present on this AttestationOccurrence, then the `serialized_payload` SHOULD be left empty. Each JWT SHOULD encode a claim specific to the `resource_uri` of this Occurrence, but this is not validated by Grafeas metadata API implementations. The JWT itself is opaque to Grafeas. { diff --git a/docs/dyn/dataplex_v1.projects.locations.dataDomains.html b/docs/dyn/dataplex_v1.projects.locations.dataDomains.html new file mode 100644 index 0000000000..9ef37a33f2 --- /dev/null +++ b/docs/dyn/dataplex_v1.projects.locations.dataDomains.html @@ -0,0 +1,258 @@ + + + +

Cloud Dataplex API . projects . locations . dataDomains

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)

+

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

+

+ setIamPolicy(resource, body=None, x__xgafv=None)

+

Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

+

+ testIamPermissions(resource, body=None, x__xgafv=None)

+

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None) +
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
+
+Args:
+  resource: string, REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+  options_requestedPolicyVersion: integer, Optional. The maximum policy version that will be used to format the policy.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset.The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role.For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).JSON example: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } YAML example: bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the IAM documentation (https://cloud.google.com/iam/docs/).
+  "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+    { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs.If there are AuditConfigs for both allServices and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted.Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.
+      "auditLogConfigs": [ # The configuration for logging of each type of permission.
+        { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
+          "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
+            "A String",
+          ],
+          "logType": "A String", # The log type that this config enables.
+        },
+      ],
+      "service": "A String", # Specifies a service that will be enabled for audit logging. For example, storage.googleapis.com, cloudsql.googleapis.com. allServices is a special value that covers all services.
+    },
+  ],
+  "bindings": [ # Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal.The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy.
+    { # Associates members, or principals, with a role.
+      "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec.Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding.If the condition evaluates to true, then this binding applies to the current request.If the condition evaluates to false, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
+        "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+        "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+        "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+        "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+      },
+      "members": [ # Specifies the principals requesting access for a Google Cloud resource. members can have the following values: allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account. allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. user:{emailid}: An email address that represents a specific Google account. For example, alice@example.com . serviceAccount:{emailid}: An email address that represents a Google service account. For example, my-other-app@appspot.gserviceaccount.com. serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]: An identifier for a Kubernetes service account (https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, my-project.svc.id.goog[my-namespace/my-kubernetes-sa]. group:{emailid}: An email address that represents a Google group. For example, admins@example.com. domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com. principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}: A single identity in a workforce identity pool. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}: All workforce identities in a group. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}: All workforce identities with a specific attribute value. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*: All identities in a workforce identity pool. principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}: A single identity in a workload identity pool. principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}: A workload identity pool group. principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}: All identities in a workload identity pool with a certain attribute. principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*: All identities in a workload identity pool. deleted:user:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a user that has been recently deleted. For example, alice@example.com?uid=123456789012345678901. If the user is recovered, this value reverts to user:{emailid} and the recovered user retains the role in the binding. deleted:serviceAccount:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901. If the service account is undeleted, this value reverts to serviceAccount:{emailid} and the undeleted service account retains the role in the binding. deleted:group:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, admins@example.com?uid=123456789012345678901. If the group is recovered, this value reverts to group:{emailid} and the recovered group retains the role in the binding. deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}: Deleted single identity in a workforce identity pool. For example, deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value.
+        "A String",
+      ],
+      "role": "A String", # Role that is assigned to the list of members, or principals. For example, roles/viewer, roles/editor, or roles/owner.For an overview of the IAM roles and permissions, see the IAM documentation (https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see here (https://cloud.google.com/iam/docs/understanding-roles).
+    },
+  ],
+  "etag": "A String", # etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.
+  "version": 42, # Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
+}
+
+ +
+ setIamPolicy(resource, body=None, x__xgafv=None) +
Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
+
+Args:
+  resource: string, REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for SetIamPolicy method.
+  "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role.For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).JSON example: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } YAML example: bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the IAM documentation (https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the resource. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them.
+    "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+      { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs.If there are AuditConfigs for both allServices and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted.Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.
+        "auditLogConfigs": [ # The configuration for logging of each type of permission.
+          { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
+            "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
+              "A String",
+            ],
+            "logType": "A String", # The log type that this config enables.
+          },
+        ],
+        "service": "A String", # Specifies a service that will be enabled for audit logging. For example, storage.googleapis.com, cloudsql.googleapis.com. allServices is a special value that covers all services.
+      },
+    ],
+    "bindings": [ # Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal.The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy.
+      { # Associates members, or principals, with a role.
+        "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec.Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding.If the condition evaluates to true, then this binding applies to the current request.If the condition evaluates to false, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
+          "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+          "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+          "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+          "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+        },
+        "members": [ # Specifies the principals requesting access for a Google Cloud resource. members can have the following values: allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account. allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. user:{emailid}: An email address that represents a specific Google account. For example, alice@example.com . serviceAccount:{emailid}: An email address that represents a Google service account. For example, my-other-app@appspot.gserviceaccount.com. serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]: An identifier for a Kubernetes service account (https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, my-project.svc.id.goog[my-namespace/my-kubernetes-sa]. group:{emailid}: An email address that represents a Google group. For example, admins@example.com. domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com. principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}: A single identity in a workforce identity pool. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}: All workforce identities in a group. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}: All workforce identities with a specific attribute value. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*: All identities in a workforce identity pool. principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}: A single identity in a workload identity pool. principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}: A workload identity pool group. principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}: All identities in a workload identity pool with a certain attribute. principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*: All identities in a workload identity pool. deleted:user:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a user that has been recently deleted. For example, alice@example.com?uid=123456789012345678901. If the user is recovered, this value reverts to user:{emailid} and the recovered user retains the role in the binding. deleted:serviceAccount:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901. If the service account is undeleted, this value reverts to serviceAccount:{emailid} and the undeleted service account retains the role in the binding. deleted:group:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, admins@example.com?uid=123456789012345678901. If the group is recovered, this value reverts to group:{emailid} and the recovered group retains the role in the binding. deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}: Deleted single identity in a workforce identity pool. For example, deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value.
+          "A String",
+        ],
+        "role": "A String", # Role that is assigned to the list of members, or principals. For example, roles/viewer, roles/editor, or roles/owner.For an overview of the IAM roles and permissions, see the IAM documentation (https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see here (https://cloud.google.com/iam/docs/understanding-roles).
+      },
+    ],
+    "etag": "A String", # etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.
+    "version": 42, # Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
+  },
+  "updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used:paths: "bindings, etag"
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role.For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).JSON example: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } YAML example: bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the IAM documentation (https://cloud.google.com/iam/docs/).
+  "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+    { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs.If there are AuditConfigs for both allServices and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted.Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.
+      "auditLogConfigs": [ # The configuration for logging of each type of permission.
+        { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
+          "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
+            "A String",
+          ],
+          "logType": "A String", # The log type that this config enables.
+        },
+      ],
+      "service": "A String", # Specifies a service that will be enabled for audit logging. For example, storage.googleapis.com, cloudsql.googleapis.com. allServices is a special value that covers all services.
+    },
+  ],
+  "bindings": [ # Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal.The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy.
+    { # Associates members, or principals, with a role.
+      "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec.Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding.If the condition evaluates to true, then this binding applies to the current request.If the condition evaluates to false, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
+        "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+        "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+        "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+        "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+      },
+      "members": [ # Specifies the principals requesting access for a Google Cloud resource. members can have the following values: allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account. allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. user:{emailid}: An email address that represents a specific Google account. For example, alice@example.com . serviceAccount:{emailid}: An email address that represents a Google service account. For example, my-other-app@appspot.gserviceaccount.com. serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]: An identifier for a Kubernetes service account (https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, my-project.svc.id.goog[my-namespace/my-kubernetes-sa]. group:{emailid}: An email address that represents a Google group. For example, admins@example.com. domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com. principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}: A single identity in a workforce identity pool. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}: All workforce identities in a group. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}: All workforce identities with a specific attribute value. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*: All identities in a workforce identity pool. principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}: A single identity in a workload identity pool. principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}: A workload identity pool group. principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}: All identities in a workload identity pool with a certain attribute. principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*: All identities in a workload identity pool. deleted:user:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a user that has been recently deleted. For example, alice@example.com?uid=123456789012345678901. If the user is recovered, this value reverts to user:{emailid} and the recovered user retains the role in the binding. deleted:serviceAccount:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901. If the service account is undeleted, this value reverts to serviceAccount:{emailid} and the undeleted service account retains the role in the binding. deleted:group:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, admins@example.com?uid=123456789012345678901. If the group is recovered, this value reverts to group:{emailid} and the recovered group retains the role in the binding. deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}: Deleted single identity in a workforce identity pool. For example, deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value.
+        "A String",
+      ],
+      "role": "A String", # Role that is assigned to the list of members, or principals. For example, roles/viewer, roles/editor, or roles/owner.For an overview of the IAM roles and permissions, see the IAM documentation (https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see here (https://cloud.google.com/iam/docs/understanding-roles).
+    },
+  ],
+  "etag": "A String", # etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.
+  "version": 42, # Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
+}
+
+ +
+ testIamPermissions(resource, body=None, x__xgafv=None) +
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
+
+Args:
+  resource: string, REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for TestIamPermissions method.
+  "permissions": [ # The set of permissions to check for the resource. Permissions with wildcards (such as * or storage.*) are not allowed. For more information see IAM Overview (https://cloud.google.com/iam/docs/overview#permissions).
+    "A String",
+  ],
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for TestIamPermissions method.
+  "permissions": [ # A subset of TestPermissionsRequest.permissions that the caller is allowed.
+    "A String",
+  ],
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/dataplex_v1.projects.locations.dataScans.html b/docs/dyn/dataplex_v1.projects.locations.dataScans.html index 1a0c368a0c..593c93139d 100644 --- a/docs/dyn/dataplex_v1.projects.locations.dataScans.html +++ b/docs/dyn/dataplex_v1.projects.locations.dataScans.html @@ -130,11 +130,11 @@

Method Details

body: object, The request body. The object takes the form of: -{ # Represents a user-visible job which provides the insights for the related data source.For example: Data quality: generates queries based on the rules and runs against the data to get data quality check results. For more information, see Auto data quality overview (https://cloud.google.com/dataplex/docs/auto-data-quality-overview). Data profile: analyzes the data in tables and generates insights about the structure, content and relationships (such as null percent, cardinality, min/max/mean, etc). For more information, see About data profiling (https://cloud.google.com/dataplex/docs/data-profiling-overview). Data discovery: scans data in Cloud Storage buckets to extract and then catalog metadata. For more information, see Discover and catalog Cloud Storage data (https://cloud.google.com/bigquery/docs/automatic-discovery). Data documentation: analyzes the table details and generates insights including descriptions and sample SQL queries for the table. For more information, see Generate data insights in BigQuery (https://cloud.google.com/bigquery/docs/data-insights). +{ # Represents a user-visible job which provides the insights for the related data source.For example: Data quality: generates queries based on the rules and runs against the data to get data quality check results. For more information, see Auto data quality overview (https://cloud.google.com/dataplex/docs/auto-data-quality-overview). Data profile: analyzes the data in tables and generates insights about the structure, content and relationships (such as null percent, cardinality, min/max/mean, etc). For more information, see About data profiling (https://cloud.google.com/dataplex/docs/data-profiling-overview). Data discovery: scans data in Cloud Storage buckets to extract and then catalog metadata. For more information, see Discover and catalog Cloud Storage data (https://cloud.google.com/bigquery/docs/automatic-discovery). Data documentation: analyzes the table or dataset metadata and generates insights. For tables, insights include descriptions and sample SQL queries. For datasets, insights include descriptions, schema relationships and sample SQL queries. For more information, see Generate data insights in BigQuery (https://cloud.google.com/bigquery/docs/data-insights). "createTime": "A String", # Output only. The time when the scan was created. "data": { # The data source for DataScan. # Required. The data source for DataScan. "entity": "A String", # Immutable. The Dataplex Universal Catalog entity that represents the data source (e.g. BigQuery table) for DataScan, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}. - "resource": "A String", # Immutable. The service-qualified full resource name of the cloud resource for a DataScan job to scan against. The field could either be: Cloud Storage bucket for DataDiscoveryScan Format: //storage.googleapis.com/projects/PROJECT_ID/buckets/BUCKET_ID or BigQuery table of type "TABLE" for DataProfileScan/DataQualityScan/DataDocumentationScan Format: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID + "resource": "A String", # Immutable. The service-qualified full resource name of the cloud resource for a DataScan job to scan against. The field could either be: Cloud Storage bucket for DataDiscoveryScan Format: //storage.googleapis.com/projects/PROJECT_ID/buckets/BUCKET_ID or BigQuery table of type "TABLE" for DataProfileScan/DataQualityScan/DataDocumentationScan Format: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID or BigQuery dataset for DataDocumentationScan only Format: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID }, "dataDiscoveryResult": { # The output of a data discovery scan. # Output only. The result of a data discovery scan. "bigqueryPublishing": { # Describes BigQuery publishing configurations. # Output only. Configuration for metadata publishing. @@ -178,10 +178,43 @@

Method Details

"encoding": "A String", # Optional. The character encoding of the data. The default is UTF-8. "typeInferenceDisabled": True or False, # Optional. Whether to disable the inference of data types for JSON data. If true, all columns are registered as their primitive types (strings, number, or boolean). }, + "unstructuredDataOptions": { # Describes options for unstructured data discovery. # Optional. Specifies configuration for unstructured data discovery. + "entityInferenceEnabled": True or False, # Optional. Deprecated: Use semantic_inference_enabled instead. Specifies whether deeper entity inference over the objects' contents using GenAI is enabled. + "semanticInferenceEnabled": True or False, # Optional. Specifies whether deeper semantic inference over the objects' contents using GenAI is enabled. + }, }, }, "dataDocumentationResult": { # The output of a DataDocumentation scan. # Output only. The result of a data documentation scan. - "tableResult": { # Generated metadata about the table. # Output only. Table result for insights. + "datasetResult": { # Insights for a dataset resource. # Output only. Insights for a Dataset resource. + "overview": "A String", # Output only. Generated Dataset description. + "queries": [ # Output only. Sample SQL queries for the dataset. + { # A sample SQL query in data documentation. + "description": "A String", # Output only. The description for the query. + "sql": "A String", # Output only. The SQL query string which can be executed. + }, + ], + "schemaRelationships": [ # Output only. Relationships suggesting how tables in the dataset are related to each other, based on their schema. + { # Details of the relationship between the schema of two resources. + "leftSchemaPaths": { # Represents an ordered set of paths within a table's schema. # Output only. An ordered list of fields for the join from the first table. The size of this list must be the same as right_schema_paths. Each field at index i in this list must correspond to a field at the same index in the right_schema_paths list. + "paths": [ # Output only. An ordered set of Paths to fields within the schema of the table. For fields nested within a top level field of type record, use '.' to separate field names. Examples: Top level field - top_level Nested field - top_level.child.sub_field + "A String", + ], + "tableFqn": "A String", # Output only. The service-qualified full resource name of the table Ex: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID + }, + "rightSchemaPaths": { # Represents an ordered set of paths within a table's schema. # Output only. An ordered list of fields for the join from the second table. The size of this list must be the same as left_schema_paths. Each field at index i in this list must correspond to a field at the same index in the left_schema_paths list. + "paths": [ # Output only. An ordered set of Paths to fields within the schema of the table. For fields nested within a top level field of type record, use '.' to separate field names. Examples: Top level field - top_level Nested field - top_level.child.sub_field + "A String", + ], + "tableFqn": "A String", # Output only. The service-qualified full resource name of the table Ex: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID + }, + "sources": [ # Output only. Sources which generated the schema relation edge. + "A String", + ], + "type": "A String", # Output only. The type of relationship between the schema paths. + }, + ], + }, + "tableResult": { # Insights for a table resource. # Output only. Insights for a Table resource. "name": "A String", # Output only. The service-qualified full resource name of the cloud resource. Ex: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID "overview": "A String", # Output only. Generated description of the table. "queries": [ # Output only. Sample SQL queries for the table. @@ -283,6 +316,7 @@

Method Details

"A String", ], }, + "mode": "A String", # Optional. The execution mode for the profile scan. "postScanActions": { # The configuration of post scan actions of DataProfileScan job. # Optional. Actions to take upon job completion.. "bigqueryExport": { # The configuration of BigQuery export post scan action. # Optional. If set, results will be exported to the provided BigQuery table. "resultsTable": "A String", # Optional. The BigQuery table to export DataProfileScan results to. Format: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID @@ -491,6 +525,15 @@

Method Details

}, "description": "A String", # Optional. Description of the scan. Must be between 1-1024 characters. "displayName": "A String", # Optional. User friendly display name. Must be between 1-256 characters. + "executionIdentity": { # The identity to run the datascan. # Optional. Immutable. The identity to run the datascan. If not specified, defaults to the Dataplex Service Agent. + "dataplexServiceAgent": { # The Dataplex service agent associated with the user's project. # Optional. The Dataplex service agent associated with the user's project. + }, + "serviceAccount": { # The service account # Optional. The provided service account. + "email": "A String", # Required. Service account email. The datascan will execute with this service account's credentials. The user calling this API must have permissions to act as this service account. Dataplex service agent must be granted iam.serviceAccounts.getAccessToken permission on this service account, for example, through the iam.serviceAccountTokenCreator role . + }, + "userCredential": { # The credential of the calling user. # Optional. The credential of the calling user. Supports only ONE_TIME trigger type. + }, + }, "executionSpec": { # DataScan execution settings. # Optional. DataScan execution settings.If not specified, the fields in it will use their default values. "field": "A String", # Immutable. The unnested field (of type Date or Timestamp) that contains values which monotonically increase over time.If not specified, a data scan will run for all data in the table. "trigger": { # DataScan scheduling and trigger settings. # Optional. Spec related to how often and when a scan should be triggered.If not specified, the default is OnDemand, which means the scan will not run until the user calls RunDataScan API. @@ -680,11 +723,11 @@

Method Details

Returns: An object of the form: - { # Represents a user-visible job which provides the insights for the related data source.For example: Data quality: generates queries based on the rules and runs against the data to get data quality check results. For more information, see Auto data quality overview (https://cloud.google.com/dataplex/docs/auto-data-quality-overview). Data profile: analyzes the data in tables and generates insights about the structure, content and relationships (such as null percent, cardinality, min/max/mean, etc). For more information, see About data profiling (https://cloud.google.com/dataplex/docs/data-profiling-overview). Data discovery: scans data in Cloud Storage buckets to extract and then catalog metadata. For more information, see Discover and catalog Cloud Storage data (https://cloud.google.com/bigquery/docs/automatic-discovery). Data documentation: analyzes the table details and generates insights including descriptions and sample SQL queries for the table. For more information, see Generate data insights in BigQuery (https://cloud.google.com/bigquery/docs/data-insights). + { # Represents a user-visible job which provides the insights for the related data source.For example: Data quality: generates queries based on the rules and runs against the data to get data quality check results. For more information, see Auto data quality overview (https://cloud.google.com/dataplex/docs/auto-data-quality-overview). Data profile: analyzes the data in tables and generates insights about the structure, content and relationships (such as null percent, cardinality, min/max/mean, etc). For more information, see About data profiling (https://cloud.google.com/dataplex/docs/data-profiling-overview). Data discovery: scans data in Cloud Storage buckets to extract and then catalog metadata. For more information, see Discover and catalog Cloud Storage data (https://cloud.google.com/bigquery/docs/automatic-discovery). Data documentation: analyzes the table or dataset metadata and generates insights. For tables, insights include descriptions and sample SQL queries. For datasets, insights include descriptions, schema relationships and sample SQL queries. For more information, see Generate data insights in BigQuery (https://cloud.google.com/bigquery/docs/data-insights). "createTime": "A String", # Output only. The time when the scan was created. "data": { # The data source for DataScan. # Required. The data source for DataScan. "entity": "A String", # Immutable. The Dataplex Universal Catalog entity that represents the data source (e.g. BigQuery table) for DataScan, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}. - "resource": "A String", # Immutable. The service-qualified full resource name of the cloud resource for a DataScan job to scan against. The field could either be: Cloud Storage bucket for DataDiscoveryScan Format: //storage.googleapis.com/projects/PROJECT_ID/buckets/BUCKET_ID or BigQuery table of type "TABLE" for DataProfileScan/DataQualityScan/DataDocumentationScan Format: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID + "resource": "A String", # Immutable. The service-qualified full resource name of the cloud resource for a DataScan job to scan against. The field could either be: Cloud Storage bucket for DataDiscoveryScan Format: //storage.googleapis.com/projects/PROJECT_ID/buckets/BUCKET_ID or BigQuery table of type "TABLE" for DataProfileScan/DataQualityScan/DataDocumentationScan Format: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID or BigQuery dataset for DataDocumentationScan only Format: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID }, "dataDiscoveryResult": { # The output of a data discovery scan. # Output only. The result of a data discovery scan. "bigqueryPublishing": { # Describes BigQuery publishing configurations. # Output only. Configuration for metadata publishing. @@ -728,10 +771,43 @@

Method Details

"encoding": "A String", # Optional. The character encoding of the data. The default is UTF-8. "typeInferenceDisabled": True or False, # Optional. Whether to disable the inference of data types for JSON data. If true, all columns are registered as their primitive types (strings, number, or boolean). }, + "unstructuredDataOptions": { # Describes options for unstructured data discovery. # Optional. Specifies configuration for unstructured data discovery. + "entityInferenceEnabled": True or False, # Optional. Deprecated: Use semantic_inference_enabled instead. Specifies whether deeper entity inference over the objects' contents using GenAI is enabled. + "semanticInferenceEnabled": True or False, # Optional. Specifies whether deeper semantic inference over the objects' contents using GenAI is enabled. + }, }, }, "dataDocumentationResult": { # The output of a DataDocumentation scan. # Output only. The result of a data documentation scan. - "tableResult": { # Generated metadata about the table. # Output only. Table result for insights. + "datasetResult": { # Insights for a dataset resource. # Output only. Insights for a Dataset resource. + "overview": "A String", # Output only. Generated Dataset description. + "queries": [ # Output only. Sample SQL queries for the dataset. + { # A sample SQL query in data documentation. + "description": "A String", # Output only. The description for the query. + "sql": "A String", # Output only. The SQL query string which can be executed. + }, + ], + "schemaRelationships": [ # Output only. Relationships suggesting how tables in the dataset are related to each other, based on their schema. + { # Details of the relationship between the schema of two resources. + "leftSchemaPaths": { # Represents an ordered set of paths within a table's schema. # Output only. An ordered list of fields for the join from the first table. The size of this list must be the same as right_schema_paths. Each field at index i in this list must correspond to a field at the same index in the right_schema_paths list. + "paths": [ # Output only. An ordered set of Paths to fields within the schema of the table. For fields nested within a top level field of type record, use '.' to separate field names. Examples: Top level field - top_level Nested field - top_level.child.sub_field + "A String", + ], + "tableFqn": "A String", # Output only. The service-qualified full resource name of the table Ex: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID + }, + "rightSchemaPaths": { # Represents an ordered set of paths within a table's schema. # Output only. An ordered list of fields for the join from the second table. The size of this list must be the same as left_schema_paths. Each field at index i in this list must correspond to a field at the same index in the left_schema_paths list. + "paths": [ # Output only. An ordered set of Paths to fields within the schema of the table. For fields nested within a top level field of type record, use '.' to separate field names. Examples: Top level field - top_level Nested field - top_level.child.sub_field + "A String", + ], + "tableFqn": "A String", # Output only. The service-qualified full resource name of the table Ex: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID + }, + "sources": [ # Output only. Sources which generated the schema relation edge. + "A String", + ], + "type": "A String", # Output only. The type of relationship between the schema paths. + }, + ], + }, + "tableResult": { # Insights for a table resource. # Output only. Insights for a Table resource. "name": "A String", # Output only. The service-qualified full resource name of the cloud resource. Ex: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID "overview": "A String", # Output only. Generated description of the table. "queries": [ # Output only. Sample SQL queries for the table. @@ -833,6 +909,7 @@

Method Details

"A String", ], }, + "mode": "A String", # Optional. The execution mode for the profile scan. "postScanActions": { # The configuration of post scan actions of DataProfileScan job. # Optional. Actions to take upon job completion.. "bigqueryExport": { # The configuration of BigQuery export post scan action. # Optional. If set, results will be exported to the provided BigQuery table. "resultsTable": "A String", # Optional. The BigQuery table to export DataProfileScan results to. Format: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID @@ -1041,6 +1118,15 @@

Method Details

}, "description": "A String", # Optional. Description of the scan. Must be between 1-1024 characters. "displayName": "A String", # Optional. User friendly display name. Must be between 1-256 characters. + "executionIdentity": { # The identity to run the datascan. # Optional. Immutable. The identity to run the datascan. If not specified, defaults to the Dataplex Service Agent. + "dataplexServiceAgent": { # The Dataplex service agent associated with the user's project. # Optional. The Dataplex service agent associated with the user's project. + }, + "serviceAccount": { # The service account # Optional. The provided service account. + "email": "A String", # Required. Service account email. The datascan will execute with this service account's credentials. The user calling this API must have permissions to act as this service account. Dataplex service agent must be granted iam.serviceAccounts.getAccessToken permission on this service account, for example, through the iam.serviceAccountTokenCreator role . + }, + "userCredential": { # The credential of the calling user. # Optional. The credential of the calling user. Supports only ONE_TIME trigger type. + }, + }, "executionSpec": { # DataScan execution settings. # Optional. DataScan execution settings.If not specified, the fields in it will use their default values. "field": "A String", # Immutable. The unnested field (of type Date or Timestamp) that contains values which monotonically increase over time.If not specified, a data scan will run for all data in the table. "trigger": { # DataScan scheduling and trigger settings. # Optional. Spec related to how often and when a scan should be triggered.If not specified, the default is OnDemand, which means the scan will not run until the user calls RunDataScan API. @@ -1138,11 +1224,11 @@

Method Details

{ # List dataScans response. "dataScans": [ # DataScans (BASIC view only) under the given parent location. - { # Represents a user-visible job which provides the insights for the related data source.For example: Data quality: generates queries based on the rules and runs against the data to get data quality check results. For more information, see Auto data quality overview (https://cloud.google.com/dataplex/docs/auto-data-quality-overview). Data profile: analyzes the data in tables and generates insights about the structure, content and relationships (such as null percent, cardinality, min/max/mean, etc). For more information, see About data profiling (https://cloud.google.com/dataplex/docs/data-profiling-overview). Data discovery: scans data in Cloud Storage buckets to extract and then catalog metadata. For more information, see Discover and catalog Cloud Storage data (https://cloud.google.com/bigquery/docs/automatic-discovery). Data documentation: analyzes the table details and generates insights including descriptions and sample SQL queries for the table. For more information, see Generate data insights in BigQuery (https://cloud.google.com/bigquery/docs/data-insights). + { # Represents a user-visible job which provides the insights for the related data source.For example: Data quality: generates queries based on the rules and runs against the data to get data quality check results. For more information, see Auto data quality overview (https://cloud.google.com/dataplex/docs/auto-data-quality-overview). Data profile: analyzes the data in tables and generates insights about the structure, content and relationships (such as null percent, cardinality, min/max/mean, etc). For more information, see About data profiling (https://cloud.google.com/dataplex/docs/data-profiling-overview). Data discovery: scans data in Cloud Storage buckets to extract and then catalog metadata. For more information, see Discover and catalog Cloud Storage data (https://cloud.google.com/bigquery/docs/automatic-discovery). Data documentation: analyzes the table or dataset metadata and generates insights. For tables, insights include descriptions and sample SQL queries. For datasets, insights include descriptions, schema relationships and sample SQL queries. For more information, see Generate data insights in BigQuery (https://cloud.google.com/bigquery/docs/data-insights). "createTime": "A String", # Output only. The time when the scan was created. "data": { # The data source for DataScan. # Required. The data source for DataScan. "entity": "A String", # Immutable. The Dataplex Universal Catalog entity that represents the data source (e.g. BigQuery table) for DataScan, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}. - "resource": "A String", # Immutable. The service-qualified full resource name of the cloud resource for a DataScan job to scan against. The field could either be: Cloud Storage bucket for DataDiscoveryScan Format: //storage.googleapis.com/projects/PROJECT_ID/buckets/BUCKET_ID or BigQuery table of type "TABLE" for DataProfileScan/DataQualityScan/DataDocumentationScan Format: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID + "resource": "A String", # Immutable. The service-qualified full resource name of the cloud resource for a DataScan job to scan against. The field could either be: Cloud Storage bucket for DataDiscoveryScan Format: //storage.googleapis.com/projects/PROJECT_ID/buckets/BUCKET_ID or BigQuery table of type "TABLE" for DataProfileScan/DataQualityScan/DataDocumentationScan Format: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID or BigQuery dataset for DataDocumentationScan only Format: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID }, "dataDiscoveryResult": { # The output of a data discovery scan. # Output only. The result of a data discovery scan. "bigqueryPublishing": { # Describes BigQuery publishing configurations. # Output only. Configuration for metadata publishing. @@ -1186,10 +1272,43 @@

Method Details

"encoding": "A String", # Optional. The character encoding of the data. The default is UTF-8. "typeInferenceDisabled": True or False, # Optional. Whether to disable the inference of data types for JSON data. If true, all columns are registered as their primitive types (strings, number, or boolean). }, + "unstructuredDataOptions": { # Describes options for unstructured data discovery. # Optional. Specifies configuration for unstructured data discovery. + "entityInferenceEnabled": True or False, # Optional. Deprecated: Use semantic_inference_enabled instead. Specifies whether deeper entity inference over the objects' contents using GenAI is enabled. + "semanticInferenceEnabled": True or False, # Optional. Specifies whether deeper semantic inference over the objects' contents using GenAI is enabled. + }, }, }, "dataDocumentationResult": { # The output of a DataDocumentation scan. # Output only. The result of a data documentation scan. - "tableResult": { # Generated metadata about the table. # Output only. Table result for insights. + "datasetResult": { # Insights for a dataset resource. # Output only. Insights for a Dataset resource. + "overview": "A String", # Output only. Generated Dataset description. + "queries": [ # Output only. Sample SQL queries for the dataset. + { # A sample SQL query in data documentation. + "description": "A String", # Output only. The description for the query. + "sql": "A String", # Output only. The SQL query string which can be executed. + }, + ], + "schemaRelationships": [ # Output only. Relationships suggesting how tables in the dataset are related to each other, based on their schema. + { # Details of the relationship between the schema of two resources. + "leftSchemaPaths": { # Represents an ordered set of paths within a table's schema. # Output only. An ordered list of fields for the join from the first table. The size of this list must be the same as right_schema_paths. Each field at index i in this list must correspond to a field at the same index in the right_schema_paths list. + "paths": [ # Output only. An ordered set of Paths to fields within the schema of the table. For fields nested within a top level field of type record, use '.' to separate field names. Examples: Top level field - top_level Nested field - top_level.child.sub_field + "A String", + ], + "tableFqn": "A String", # Output only. The service-qualified full resource name of the table Ex: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID + }, + "rightSchemaPaths": { # Represents an ordered set of paths within a table's schema. # Output only. An ordered list of fields for the join from the second table. The size of this list must be the same as left_schema_paths. Each field at index i in this list must correspond to a field at the same index in the left_schema_paths list. + "paths": [ # Output only. An ordered set of Paths to fields within the schema of the table. For fields nested within a top level field of type record, use '.' to separate field names. Examples: Top level field - top_level Nested field - top_level.child.sub_field + "A String", + ], + "tableFqn": "A String", # Output only. The service-qualified full resource name of the table Ex: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID + }, + "sources": [ # Output only. Sources which generated the schema relation edge. + "A String", + ], + "type": "A String", # Output only. The type of relationship between the schema paths. + }, + ], + }, + "tableResult": { # Insights for a table resource. # Output only. Insights for a Table resource. "name": "A String", # Output only. The service-qualified full resource name of the cloud resource. Ex: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID "overview": "A String", # Output only. Generated description of the table. "queries": [ # Output only. Sample SQL queries for the table. @@ -1291,6 +1410,7 @@

Method Details

"A String", ], }, + "mode": "A String", # Optional. The execution mode for the profile scan. "postScanActions": { # The configuration of post scan actions of DataProfileScan job. # Optional. Actions to take upon job completion.. "bigqueryExport": { # The configuration of BigQuery export post scan action. # Optional. If set, results will be exported to the provided BigQuery table. "resultsTable": "A String", # Optional. The BigQuery table to export DataProfileScan results to. Format: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID @@ -1499,6 +1619,15 @@

Method Details

}, "description": "A String", # Optional. Description of the scan. Must be between 1-1024 characters. "displayName": "A String", # Optional. User friendly display name. Must be between 1-256 characters. + "executionIdentity": { # The identity to run the datascan. # Optional. Immutable. The identity to run the datascan. If not specified, defaults to the Dataplex Service Agent. + "dataplexServiceAgent": { # The Dataplex service agent associated with the user's project. # Optional. The Dataplex service agent associated with the user's project. + }, + "serviceAccount": { # The service account # Optional. The provided service account. + "email": "A String", # Required. Service account email. The datascan will execute with this service account's credentials. The user calling this API must have permissions to act as this service account. Dataplex service agent must be granted iam.serviceAccounts.getAccessToken permission on this service account, for example, through the iam.serviceAccountTokenCreator role . + }, + "userCredential": { # The credential of the calling user. # Optional. The credential of the calling user. Supports only ONE_TIME trigger type. + }, + }, "executionSpec": { # DataScan execution settings. # Optional. DataScan execution settings.If not specified, the fields in it will use their default values. "field": "A String", # Immutable. The unnested field (of type Date or Timestamp) that contains values which monotonically increase over time.If not specified, a data scan will run for all data in the table. "trigger": { # DataScan scheduling and trigger settings. # Optional. Spec related to how often and when a scan should be triggered.If not specified, the default is OnDemand, which means the scan will not run until the user calls RunDataScan API. @@ -1557,11 +1686,11 @@

Method Details

body: object, The request body. The object takes the form of: -{ # Represents a user-visible job which provides the insights for the related data source.For example: Data quality: generates queries based on the rules and runs against the data to get data quality check results. For more information, see Auto data quality overview (https://cloud.google.com/dataplex/docs/auto-data-quality-overview). Data profile: analyzes the data in tables and generates insights about the structure, content and relationships (such as null percent, cardinality, min/max/mean, etc). For more information, see About data profiling (https://cloud.google.com/dataplex/docs/data-profiling-overview). Data discovery: scans data in Cloud Storage buckets to extract and then catalog metadata. For more information, see Discover and catalog Cloud Storage data (https://cloud.google.com/bigquery/docs/automatic-discovery). Data documentation: analyzes the table details and generates insights including descriptions and sample SQL queries for the table. For more information, see Generate data insights in BigQuery (https://cloud.google.com/bigquery/docs/data-insights). +{ # Represents a user-visible job which provides the insights for the related data source.For example: Data quality: generates queries based on the rules and runs against the data to get data quality check results. For more information, see Auto data quality overview (https://cloud.google.com/dataplex/docs/auto-data-quality-overview). Data profile: analyzes the data in tables and generates insights about the structure, content and relationships (such as null percent, cardinality, min/max/mean, etc). For more information, see About data profiling (https://cloud.google.com/dataplex/docs/data-profiling-overview). Data discovery: scans data in Cloud Storage buckets to extract and then catalog metadata. For more information, see Discover and catalog Cloud Storage data (https://cloud.google.com/bigquery/docs/automatic-discovery). Data documentation: analyzes the table or dataset metadata and generates insights. For tables, insights include descriptions and sample SQL queries. For datasets, insights include descriptions, schema relationships and sample SQL queries. For more information, see Generate data insights in BigQuery (https://cloud.google.com/bigquery/docs/data-insights). "createTime": "A String", # Output only. The time when the scan was created. "data": { # The data source for DataScan. # Required. The data source for DataScan. "entity": "A String", # Immutable. The Dataplex Universal Catalog entity that represents the data source (e.g. BigQuery table) for DataScan, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}. - "resource": "A String", # Immutable. The service-qualified full resource name of the cloud resource for a DataScan job to scan against. The field could either be: Cloud Storage bucket for DataDiscoveryScan Format: //storage.googleapis.com/projects/PROJECT_ID/buckets/BUCKET_ID or BigQuery table of type "TABLE" for DataProfileScan/DataQualityScan/DataDocumentationScan Format: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID + "resource": "A String", # Immutable. The service-qualified full resource name of the cloud resource for a DataScan job to scan against. The field could either be: Cloud Storage bucket for DataDiscoveryScan Format: //storage.googleapis.com/projects/PROJECT_ID/buckets/BUCKET_ID or BigQuery table of type "TABLE" for DataProfileScan/DataQualityScan/DataDocumentationScan Format: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID or BigQuery dataset for DataDocumentationScan only Format: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID }, "dataDiscoveryResult": { # The output of a data discovery scan. # Output only. The result of a data discovery scan. "bigqueryPublishing": { # Describes BigQuery publishing configurations. # Output only. Configuration for metadata publishing. @@ -1605,10 +1734,43 @@

Method Details

"encoding": "A String", # Optional. The character encoding of the data. The default is UTF-8. "typeInferenceDisabled": True or False, # Optional. Whether to disable the inference of data types for JSON data. If true, all columns are registered as their primitive types (strings, number, or boolean). }, + "unstructuredDataOptions": { # Describes options for unstructured data discovery. # Optional. Specifies configuration for unstructured data discovery. + "entityInferenceEnabled": True or False, # Optional. Deprecated: Use semantic_inference_enabled instead. Specifies whether deeper entity inference over the objects' contents using GenAI is enabled. + "semanticInferenceEnabled": True or False, # Optional. Specifies whether deeper semantic inference over the objects' contents using GenAI is enabled. + }, }, }, "dataDocumentationResult": { # The output of a DataDocumentation scan. # Output only. The result of a data documentation scan. - "tableResult": { # Generated metadata about the table. # Output only. Table result for insights. + "datasetResult": { # Insights for a dataset resource. # Output only. Insights for a Dataset resource. + "overview": "A String", # Output only. Generated Dataset description. + "queries": [ # Output only. Sample SQL queries for the dataset. + { # A sample SQL query in data documentation. + "description": "A String", # Output only. The description for the query. + "sql": "A String", # Output only. The SQL query string which can be executed. + }, + ], + "schemaRelationships": [ # Output only. Relationships suggesting how tables in the dataset are related to each other, based on their schema. + { # Details of the relationship between the schema of two resources. + "leftSchemaPaths": { # Represents an ordered set of paths within a table's schema. # Output only. An ordered list of fields for the join from the first table. The size of this list must be the same as right_schema_paths. Each field at index i in this list must correspond to a field at the same index in the right_schema_paths list. + "paths": [ # Output only. An ordered set of Paths to fields within the schema of the table. For fields nested within a top level field of type record, use '.' to separate field names. Examples: Top level field - top_level Nested field - top_level.child.sub_field + "A String", + ], + "tableFqn": "A String", # Output only. The service-qualified full resource name of the table Ex: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID + }, + "rightSchemaPaths": { # Represents an ordered set of paths within a table's schema. # Output only. An ordered list of fields for the join from the second table. The size of this list must be the same as left_schema_paths. Each field at index i in this list must correspond to a field at the same index in the left_schema_paths list. + "paths": [ # Output only. An ordered set of Paths to fields within the schema of the table. For fields nested within a top level field of type record, use '.' to separate field names. Examples: Top level field - top_level Nested field - top_level.child.sub_field + "A String", + ], + "tableFqn": "A String", # Output only. The service-qualified full resource name of the table Ex: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID + }, + "sources": [ # Output only. Sources which generated the schema relation edge. + "A String", + ], + "type": "A String", # Output only. The type of relationship between the schema paths. + }, + ], + }, + "tableResult": { # Insights for a table resource. # Output only. Insights for a Table resource. "name": "A String", # Output only. The service-qualified full resource name of the cloud resource. Ex: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID "overview": "A String", # Output only. Generated description of the table. "queries": [ # Output only. Sample SQL queries for the table. @@ -1710,6 +1872,7 @@

Method Details

"A String", ], }, + "mode": "A String", # Optional. The execution mode for the profile scan. "postScanActions": { # The configuration of post scan actions of DataProfileScan job. # Optional. Actions to take upon job completion.. "bigqueryExport": { # The configuration of BigQuery export post scan action. # Optional. If set, results will be exported to the provided BigQuery table. "resultsTable": "A String", # Optional. The BigQuery table to export DataProfileScan results to. Format: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID @@ -1918,6 +2081,15 @@

Method Details

}, "description": "A String", # Optional. Description of the scan. Must be between 1-1024 characters. "displayName": "A String", # Optional. User friendly display name. Must be between 1-256 characters. + "executionIdentity": { # The identity to run the datascan. # Optional. Immutable. The identity to run the datascan. If not specified, defaults to the Dataplex Service Agent. + "dataplexServiceAgent": { # The Dataplex service agent associated with the user's project. # Optional. The Dataplex service agent associated with the user's project. + }, + "serviceAccount": { # The service account # Optional. The provided service account. + "email": "A String", # Required. Service account email. The datascan will execute with this service account's credentials. The user calling this API must have permissions to act as this service account. Dataplex service agent must be granted iam.serviceAccounts.getAccessToken permission on this service account, for example, through the iam.serviceAccountTokenCreator role . + }, + "userCredential": { # The credential of the calling user. # Optional. The credential of the calling user. Supports only ONE_TIME trigger type. + }, + }, "executionSpec": { # DataScan execution settings. # Optional. DataScan execution settings.If not specified, the fields in it will use their default values. "field": "A String", # Immutable. The unnested field (of type Date or Timestamp) that contains values which monotonically increase over time.If not specified, a data scan will run for all data in the table. "trigger": { # DataScan scheduling and trigger settings. # Optional. Spec related to how often and when a scan should be triggered.If not specified, the default is OnDemand, which means the scan will not run until the user calls RunDataScan API. @@ -2042,10 +2214,43 @@

Method Details

"encoding": "A String", # Optional. The character encoding of the data. The default is UTF-8. "typeInferenceDisabled": True or False, # Optional. Whether to disable the inference of data types for JSON data. If true, all columns are registered as their primitive types (strings, number, or boolean). }, + "unstructuredDataOptions": { # Describes options for unstructured data discovery. # Optional. Specifies configuration for unstructured data discovery. + "entityInferenceEnabled": True or False, # Optional. Deprecated: Use semantic_inference_enabled instead. Specifies whether deeper entity inference over the objects' contents using GenAI is enabled. + "semanticInferenceEnabled": True or False, # Optional. Specifies whether deeper semantic inference over the objects' contents using GenAI is enabled. + }, }, }, "dataDocumentationResult": { # The output of a DataDocumentation scan. # Output only. The result of a data documentation scan. - "tableResult": { # Generated metadata about the table. # Output only. Table result for insights. + "datasetResult": { # Insights for a dataset resource. # Output only. Insights for a Dataset resource. + "overview": "A String", # Output only. Generated Dataset description. + "queries": [ # Output only. Sample SQL queries for the dataset. + { # A sample SQL query in data documentation. + "description": "A String", # Output only. The description for the query. + "sql": "A String", # Output only. The SQL query string which can be executed. + }, + ], + "schemaRelationships": [ # Output only. Relationships suggesting how tables in the dataset are related to each other, based on their schema. + { # Details of the relationship between the schema of two resources. + "leftSchemaPaths": { # Represents an ordered set of paths within a table's schema. # Output only. An ordered list of fields for the join from the first table. The size of this list must be the same as right_schema_paths. Each field at index i in this list must correspond to a field at the same index in the right_schema_paths list. + "paths": [ # Output only. An ordered set of Paths to fields within the schema of the table. For fields nested within a top level field of type record, use '.' to separate field names. Examples: Top level field - top_level Nested field - top_level.child.sub_field + "A String", + ], + "tableFqn": "A String", # Output only. The service-qualified full resource name of the table Ex: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID + }, + "rightSchemaPaths": { # Represents an ordered set of paths within a table's schema. # Output only. An ordered list of fields for the join from the second table. The size of this list must be the same as left_schema_paths. Each field at index i in this list must correspond to a field at the same index in the left_schema_paths list. + "paths": [ # Output only. An ordered set of Paths to fields within the schema of the table. For fields nested within a top level field of type record, use '.' to separate field names. Examples: Top level field - top_level Nested field - top_level.child.sub_field + "A String", + ], + "tableFqn": "A String", # Output only. The service-qualified full resource name of the table Ex: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID + }, + "sources": [ # Output only. Sources which generated the schema relation edge. + "A String", + ], + "type": "A String", # Output only. The type of relationship between the schema paths. + }, + ], + }, + "tableResult": { # Insights for a table resource. # Output only. Insights for a Table resource. "name": "A String", # Output only. The service-qualified full resource name of the cloud resource. Ex: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID "overview": "A String", # Output only. Generated description of the table. "queries": [ # Output only. Sample SQL queries for the table. @@ -2147,6 +2352,7 @@

Method Details

"A String", ], }, + "mode": "A String", # Optional. The execution mode for the profile scan. "postScanActions": { # The configuration of post scan actions of DataProfileScan job. # Optional. Actions to take upon job completion.. "bigqueryExport": { # The configuration of BigQuery export post scan action. # Optional. If set, results will be exported to the provided BigQuery table. "resultsTable": "A String", # Optional. The BigQuery table to export DataProfileScan results to. Format: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID @@ -2356,6 +2562,7 @@

Method Details

"endTime": "A String", # Output only. The time when the DataScanJob ended. "message": "A String", # Output only. Additional information about the current state. "name": "A String", # Output only. Identifier. The relative resource name of the DataScanJob, of the form: projects/{project}/locations/{location_id}/dataScans/{datascan_id}/jobs/{job_id}, where project refers to a project_id or project_number and location_id refers to a Google Cloud region. + "partialFailureMessage": "A String", # Output only. A message indicating partial failure details. "startTime": "A String", # Output only. The time when the DataScanJob was started. "state": "A String", # Output only. Execution state for the DataScanJob. "type": "A String", # Output only. The type of the parent DataScan. diff --git a/docs/dyn/dataplex_v1.projects.locations.dataScans.jobs.html b/docs/dyn/dataplex_v1.projects.locations.dataScans.jobs.html index d8a0908535..bb56464f28 100644 --- a/docs/dyn/dataplex_v1.projects.locations.dataScans.jobs.html +++ b/docs/dyn/dataplex_v1.projects.locations.dataScans.jobs.html @@ -233,10 +233,43 @@

Method Details

"encoding": "A String", # Optional. The character encoding of the data. The default is UTF-8. "typeInferenceDisabled": True or False, # Optional. Whether to disable the inference of data types for JSON data. If true, all columns are registered as their primitive types (strings, number, or boolean). }, + "unstructuredDataOptions": { # Describes options for unstructured data discovery. # Optional. Specifies configuration for unstructured data discovery. + "entityInferenceEnabled": True or False, # Optional. Deprecated: Use semantic_inference_enabled instead. Specifies whether deeper entity inference over the objects' contents using GenAI is enabled. + "semanticInferenceEnabled": True or False, # Optional. Specifies whether deeper semantic inference over the objects' contents using GenAI is enabled. + }, }, }, "dataDocumentationResult": { # The output of a DataDocumentation scan. # Output only. The result of a data documentation scan. - "tableResult": { # Generated metadata about the table. # Output only. Table result for insights. + "datasetResult": { # Insights for a dataset resource. # Output only. Insights for a Dataset resource. + "overview": "A String", # Output only. Generated Dataset description. + "queries": [ # Output only. Sample SQL queries for the dataset. + { # A sample SQL query in data documentation. + "description": "A String", # Output only. The description for the query. + "sql": "A String", # Output only. The SQL query string which can be executed. + }, + ], + "schemaRelationships": [ # Output only. Relationships suggesting how tables in the dataset are related to each other, based on their schema. + { # Details of the relationship between the schema of two resources. + "leftSchemaPaths": { # Represents an ordered set of paths within a table's schema. # Output only. An ordered list of fields for the join from the first table. The size of this list must be the same as right_schema_paths. Each field at index i in this list must correspond to a field at the same index in the right_schema_paths list. + "paths": [ # Output only. An ordered set of Paths to fields within the schema of the table. For fields nested within a top level field of type record, use '.' to separate field names. Examples: Top level field - top_level Nested field - top_level.child.sub_field + "A String", + ], + "tableFqn": "A String", # Output only. The service-qualified full resource name of the table Ex: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID + }, + "rightSchemaPaths": { # Represents an ordered set of paths within a table's schema. # Output only. An ordered list of fields for the join from the second table. The size of this list must be the same as left_schema_paths. Each field at index i in this list must correspond to a field at the same index in the left_schema_paths list. + "paths": [ # Output only. An ordered set of Paths to fields within the schema of the table. For fields nested within a top level field of type record, use '.' to separate field names. Examples: Top level field - top_level Nested field - top_level.child.sub_field + "A String", + ], + "tableFqn": "A String", # Output only. The service-qualified full resource name of the table Ex: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID + }, + "sources": [ # Output only. Sources which generated the schema relation edge. + "A String", + ], + "type": "A String", # Output only. The type of relationship between the schema paths. + }, + ], + }, + "tableResult": { # Insights for a table resource. # Output only. Insights for a Table resource. "name": "A String", # Output only. The service-qualified full resource name of the cloud resource. Ex: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID "overview": "A String", # Output only. Generated description of the table. "queries": [ # Output only. Sample SQL queries for the table. @@ -338,6 +371,7 @@

Method Details

"A String", ], }, + "mode": "A String", # Optional. The execution mode for the profile scan. "postScanActions": { # The configuration of post scan actions of DataProfileScan job. # Optional. Actions to take upon job completion.. "bigqueryExport": { # The configuration of BigQuery export post scan action. # Optional. If set, results will be exported to the provided BigQuery table. "resultsTable": "A String", # Optional. The BigQuery table to export DataProfileScan results to. Format: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID @@ -547,6 +581,7 @@

Method Details

"endTime": "A String", # Output only. The time when the DataScanJob ended. "message": "A String", # Output only. Additional information about the current state. "name": "A String", # Output only. Identifier. The relative resource name of the DataScanJob, of the form: projects/{project}/locations/{location_id}/dataScans/{datascan_id}/jobs/{job_id}, where project refers to a project_id or project_number and location_id refers to a Google Cloud region. + "partialFailureMessage": "A String", # Output only. A message indicating partial failure details. "startTime": "A String", # Output only. The time when the DataScanJob was started. "state": "A String", # Output only. Execution state for the DataScanJob. "type": "A String", # Output only. The type of the parent DataScan. @@ -617,10 +652,43 @@

Method Details

"encoding": "A String", # Optional. The character encoding of the data. The default is UTF-8. "typeInferenceDisabled": True or False, # Optional. Whether to disable the inference of data types for JSON data. If true, all columns are registered as their primitive types (strings, number, or boolean). }, + "unstructuredDataOptions": { # Describes options for unstructured data discovery. # Optional. Specifies configuration for unstructured data discovery. + "entityInferenceEnabled": True or False, # Optional. Deprecated: Use semantic_inference_enabled instead. Specifies whether deeper entity inference over the objects' contents using GenAI is enabled. + "semanticInferenceEnabled": True or False, # Optional. Specifies whether deeper semantic inference over the objects' contents using GenAI is enabled. + }, }, }, "dataDocumentationResult": { # The output of a DataDocumentation scan. # Output only. The result of a data documentation scan. - "tableResult": { # Generated metadata about the table. # Output only. Table result for insights. + "datasetResult": { # Insights for a dataset resource. # Output only. Insights for a Dataset resource. + "overview": "A String", # Output only. Generated Dataset description. + "queries": [ # Output only. Sample SQL queries for the dataset. + { # A sample SQL query in data documentation. + "description": "A String", # Output only. The description for the query. + "sql": "A String", # Output only. The SQL query string which can be executed. + }, + ], + "schemaRelationships": [ # Output only. Relationships suggesting how tables in the dataset are related to each other, based on their schema. + { # Details of the relationship between the schema of two resources. + "leftSchemaPaths": { # Represents an ordered set of paths within a table's schema. # Output only. An ordered list of fields for the join from the first table. The size of this list must be the same as right_schema_paths. Each field at index i in this list must correspond to a field at the same index in the right_schema_paths list. + "paths": [ # Output only. An ordered set of Paths to fields within the schema of the table. For fields nested within a top level field of type record, use '.' to separate field names. Examples: Top level field - top_level Nested field - top_level.child.sub_field + "A String", + ], + "tableFqn": "A String", # Output only. The service-qualified full resource name of the table Ex: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID + }, + "rightSchemaPaths": { # Represents an ordered set of paths within a table's schema. # Output only. An ordered list of fields for the join from the second table. The size of this list must be the same as left_schema_paths. Each field at index i in this list must correspond to a field at the same index in the left_schema_paths list. + "paths": [ # Output only. An ordered set of Paths to fields within the schema of the table. For fields nested within a top level field of type record, use '.' to separate field names. Examples: Top level field - top_level Nested field - top_level.child.sub_field + "A String", + ], + "tableFqn": "A String", # Output only. The service-qualified full resource name of the table Ex: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID + }, + "sources": [ # Output only. Sources which generated the schema relation edge. + "A String", + ], + "type": "A String", # Output only. The type of relationship between the schema paths. + }, + ], + }, + "tableResult": { # Insights for a table resource. # Output only. Insights for a Table resource. "name": "A String", # Output only. The service-qualified full resource name of the cloud resource. Ex: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID "overview": "A String", # Output only. Generated description of the table. "queries": [ # Output only. Sample SQL queries for the table. @@ -722,6 +790,7 @@

Method Details

"A String", ], }, + "mode": "A String", # Optional. The execution mode for the profile scan. "postScanActions": { # The configuration of post scan actions of DataProfileScan job. # Optional. Actions to take upon job completion.. "bigqueryExport": { # The configuration of BigQuery export post scan action. # Optional. If set, results will be exported to the provided BigQuery table. "resultsTable": "A String", # Optional. The BigQuery table to export DataProfileScan results to. Format: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID @@ -931,6 +1000,7 @@

Method Details

"endTime": "A String", # Output only. The time when the DataScanJob ended. "message": "A String", # Output only. Additional information about the current state. "name": "A String", # Output only. Identifier. The relative resource name of the DataScanJob, of the form: projects/{project}/locations/{location_id}/dataScans/{datascan_id}/jobs/{job_id}, where project refers to a project_id or project_number and location_id refers to a Google Cloud region. + "partialFailureMessage": "A String", # Output only. A message indicating partial failure details. "startTime": "A String", # Output only. The time when the DataScanJob was started. "state": "A String", # Output only. Execution state for the DataScanJob. "type": "A String", # Output only. The type of the parent DataScan. diff --git a/docs/dyn/dataplex_v1.projects.locations.entryGroups.entries.html b/docs/dyn/dataplex_v1.projects.locations.entryGroups.entries.html index 9e5ff2417a..9554dca75e 100644 --- a/docs/dyn/dataplex_v1.projects.locations.entryGroups.entries.html +++ b/docs/dyn/dataplex_v1.projects.locations.entryGroups.entries.html @@ -112,7 +112,7 @@

Method Details

{ # An entry is a representation of a data resource that can be described by various metadata. "aspects": { # Optional. The aspects that are attached to the entry. Depending on how the aspect is attached to the entry, the format of the aspect key can be one of the following: If the aspect is attached directly to the entry: {project_id_or_number}.{location_id}.{aspect_type_id} If the aspect is attached to an entry's path: {project_id_or_number}.{location_id}.{aspect_type_id}@{path} - "a_key": { # An aspect is a single piece of metadata describing an entry. + "a_key": { # Represents a single piece of metadata describing an entry or entry link. "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect. "createTime": "A String", # The time the aspect was created in the source system. "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc). @@ -165,7 +165,7 @@

Method Details

{ # An entry is a representation of a data resource that can be described by various metadata. "aspects": { # Optional. The aspects that are attached to the entry. Depending on how the aspect is attached to the entry, the format of the aspect key can be one of the following: If the aspect is attached directly to the entry: {project_id_or_number}.{location_id}.{aspect_type_id} If the aspect is attached to an entry's path: {project_id_or_number}.{location_id}.{aspect_type_id}@{path} - "a_key": { # An aspect is a single piece of metadata describing an entry. + "a_key": { # Represents a single piece of metadata describing an entry or entry link. "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect. "createTime": "A String", # The time the aspect was created in the source system. "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc). @@ -224,7 +224,7 @@

Method Details

{ # An entry is a representation of a data resource that can be described by various metadata. "aspects": { # Optional. The aspects that are attached to the entry. Depending on how the aspect is attached to the entry, the format of the aspect key can be one of the following: If the aspect is attached directly to the entry: {project_id_or_number}.{location_id}.{aspect_type_id} If the aspect is attached to an entry's path: {project_id_or_number}.{location_id}.{aspect_type_id}@{path} - "a_key": { # An aspect is a single piece of metadata describing an entry. + "a_key": { # Represents a single piece of metadata describing an entry or entry link. "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect. "createTime": "A String", # The time the aspect was created in the source system. "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc). @@ -292,7 +292,7 @@

Method Details

{ # An entry is a representation of a data resource that can be described by various metadata. "aspects": { # Optional. The aspects that are attached to the entry. Depending on how the aspect is attached to the entry, the format of the aspect key can be one of the following: If the aspect is attached directly to the entry: {project_id_or_number}.{location_id}.{aspect_type_id} If the aspect is attached to an entry's path: {project_id_or_number}.{location_id}.{aspect_type_id}@{path} - "a_key": { # An aspect is a single piece of metadata describing an entry. + "a_key": { # Represents a single piece of metadata describing an entry or entry link. "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect. "createTime": "A String", # The time the aspect was created in the source system. "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc). @@ -356,7 +356,7 @@

Method Details

"entries": [ # The list of entries under the given parent location. { # An entry is a representation of a data resource that can be described by various metadata. "aspects": { # Optional. The aspects that are attached to the entry. Depending on how the aspect is attached to the entry, the format of the aspect key can be one of the following: If the aspect is attached directly to the entry: {project_id_or_number}.{location_id}.{aspect_type_id} If the aspect is attached to an entry's path: {project_id_or_number}.{location_id}.{aspect_type_id}@{path} - "a_key": { # An aspect is a single piece of metadata describing an entry. + "a_key": { # Represents a single piece of metadata describing an entry or entry link. "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect. "createTime": "A String", # The time the aspect was created in the source system. "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc). @@ -427,7 +427,7 @@

Method Details

{ # An entry is a representation of a data resource that can be described by various metadata. "aspects": { # Optional. The aspects that are attached to the entry. Depending on how the aspect is attached to the entry, the format of the aspect key can be one of the following: If the aspect is attached directly to the entry: {project_id_or_number}.{location_id}.{aspect_type_id} If the aspect is attached to an entry's path: {project_id_or_number}.{location_id}.{aspect_type_id}@{path} - "a_key": { # An aspect is a single piece of metadata describing an entry. + "a_key": { # Represents a single piece of metadata describing an entry or entry link. "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect. "createTime": "A String", # The time the aspect was created in the source system. "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc). @@ -483,7 +483,7 @@

Method Details

{ # An entry is a representation of a data resource that can be described by various metadata. "aspects": { # Optional. The aspects that are attached to the entry. Depending on how the aspect is attached to the entry, the format of the aspect key can be one of the following: If the aspect is attached directly to the entry: {project_id_or_number}.{location_id}.{aspect_type_id} If the aspect is attached to an entry's path: {project_id_or_number}.{location_id}.{aspect_type_id}@{path} - "a_key": { # An aspect is a single piece of metadata describing an entry. + "a_key": { # Represents a single piece of metadata describing an entry or entry link. "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect. "createTime": "A String", # The time the aspect was created in the source system. "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc). diff --git a/docs/dyn/dataplex_v1.projects.locations.entryGroups.entryLinks.html b/docs/dyn/dataplex_v1.projects.locations.entryGroups.entryLinks.html index d3ea946c38..65a79e6644 100644 --- a/docs/dyn/dataplex_v1.projects.locations.entryGroups.entryLinks.html +++ b/docs/dyn/dataplex_v1.projects.locations.entryGroups.entryLinks.html @@ -106,7 +106,7 @@

Method Details

{ # EntryLink represents a link between two Entries. "aspects": { # Optional. The aspects that are attached to the entry link. The format of the aspect key has to be the following: {project_id_or_number}.{location_id}.{aspect_type_id} Currently, only a single aspect of a Dataplex-owned Aspect Type is allowed. - "a_key": { # An aspect is a single piece of metadata describing an entry. + "a_key": { # Represents a single piece of metadata describing an entry or entry link. "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect. "createTime": "A String", # The time the aspect was created in the source system. "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc). @@ -145,7 +145,7 @@

Method Details

{ # EntryLink represents a link between two Entries. "aspects": { # Optional. The aspects that are attached to the entry link. The format of the aspect key has to be the following: {project_id_or_number}.{location_id}.{aspect_type_id} Currently, only a single aspect of a Dataplex-owned Aspect Type is allowed. - "a_key": { # An aspect is a single piece of metadata describing an entry. + "a_key": { # Represents a single piece of metadata describing an entry or entry link. "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect. "createTime": "A String", # The time the aspect was created in the source system. "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc). @@ -190,7 +190,7 @@

Method Details

{ # EntryLink represents a link between two Entries. "aspects": { # Optional. The aspects that are attached to the entry link. The format of the aspect key has to be the following: {project_id_or_number}.{location_id}.{aspect_type_id} Currently, only a single aspect of a Dataplex-owned Aspect Type is allowed. - "a_key": { # An aspect is a single piece of metadata describing an entry. + "a_key": { # Represents a single piece of metadata describing an entry or entry link. "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect. "createTime": "A String", # The time the aspect was created in the source system. "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc). @@ -235,7 +235,7 @@

Method Details

{ # EntryLink represents a link between two Entries. "aspects": { # Optional. The aspects that are attached to the entry link. The format of the aspect key has to be the following: {project_id_or_number}.{location_id}.{aspect_type_id} Currently, only a single aspect of a Dataplex-owned Aspect Type is allowed. - "a_key": { # An aspect is a single piece of metadata describing an entry. + "a_key": { # Represents a single piece of metadata describing an entry or entry link. "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect. "createTime": "A String", # The time the aspect was created in the source system. "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc). @@ -275,7 +275,7 @@

Method Details

{ # EntryLink represents a link between two Entries. "aspects": { # Optional. The aspects that are attached to the entry link. The format of the aspect key has to be the following: {project_id_or_number}.{location_id}.{aspect_type_id} Currently, only a single aspect of a Dataplex-owned Aspect Type is allowed. - "a_key": { # An aspect is a single piece of metadata describing an entry. + "a_key": { # Represents a single piece of metadata describing an entry or entry link. "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect. "createTime": "A String", # The time the aspect was created in the source system. "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc). @@ -315,7 +315,7 @@

Method Details

{ # EntryLink represents a link between two Entries. "aspects": { # Optional. The aspects that are attached to the entry link. The format of the aspect key has to be the following: {project_id_or_number}.{location_id}.{aspect_type_id} Currently, only a single aspect of a Dataplex-owned Aspect Type is allowed. - "a_key": { # An aspect is a single piece of metadata describing an entry. + "a_key": { # Represents a single piece of metadata describing an entry or entry link. "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect. "createTime": "A String", # The time the aspect was created in the source system. "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc). diff --git a/docs/dyn/dataplex_v1.projects.locations.html b/docs/dyn/dataplex_v1.projects.locations.html index 455d58479b..72092f175b 100644 --- a/docs/dyn/dataplex_v1.projects.locations.html +++ b/docs/dyn/dataplex_v1.projects.locations.html @@ -89,6 +89,11 @@

Instance Methods

Returns the dataAttributeBindings Resource.

+

+ dataDomains() +

+

Returns the dataDomains Resource.

+

dataProducts()

@@ -162,7 +167,7 @@

Instance Methods

Gets information about a location.

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

-

Lists information about the supported locations for this service. This method can be called in two ways: List all public locations: Use the path GET /v1/locations. List project-visible locations: Use the path GET /v1/projects/{project_id}/locations. This may include public locations as well as private or other locations specifically visible to the project.

+

Lists information about the supported locations for this service.This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: Global locations: If name is empty, the method lists the public locations available to all projects. Project-specific locations: If name follows the format projects/{project}, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project.For gRPC and client library implementations, the resource name is passed as the name field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.

list_next()

Retrieves the next page of results.

@@ -178,6 +183,9 @@

Instance Methods

lookupEntryLinks_next()

Retrieves the next page of results.

+

+ modifyEntry(name, body=None, x__xgafv=None)

+

Modifies an entry using the permission on the source system.

searchEntries(name, orderBy=None, pageSize=None, pageToken=None, query=None, scope=None, semanticSearch=None, x__xgafv=None)

Searches for Entries matching the given query and scope.

@@ -219,7 +227,7 @@

Method Details

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists information about the supported locations for this service. This method can be called in two ways: List all public locations: Use the path GET /v1/locations. List project-visible locations: Use the path GET /v1/projects/{project_id}/locations. This may include public locations as well as private or other locations specifically visible to the project.
+  
Lists information about the supported locations for this service.This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: Global locations: If name is empty, the method lists the public locations available to all projects. Project-specific locations: If name follows the format projects/{project}, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project.For gRPC and client library implementations, the resource name is passed as the name field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
@@ -277,10 +285,10 @@ 

Method Details

The object takes the form of: { # Lookup Context using permissions in the source system. - "options": { # Optional. Allows to configure the context. + "options": { # Optional. Allows to configure the context.Supported options: format - The format of the context (one of yaml, xml, json, default is yaml). context_budget - If provided, the output will be intelligently truncated on a best-effort basis to contain approximately the desired amount of characters. There is no guarantee to achieve the specific amount. "a_key": "A String", }, - "resources": [ # Required. The entry names to lookup context for. The request should have max 10 of those.Examples:projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry} + "resources": [ # Required. The entry names to look up the context for. The maximum number of resources for a request is limited to 10.Examples:projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry} "A String", ], } @@ -294,7 +302,7 @@

Method Details

An object of the form: { # Lookup Context response. - "context": "A String", # LLM generated context for the resources. + "context": "A String", # Pre-formatted block of text containing the context for the requested resources. }
@@ -324,7 +332,7 @@

Method Details

{ # An entry is a representation of a data resource that can be described by various metadata. "aspects": { # Optional. The aspects that are attached to the entry. Depending on how the aspect is attached to the entry, the format of the aspect key can be one of the following: If the aspect is attached directly to the entry: {project_id_or_number}.{location_id}.{aspect_type_id} If the aspect is attached to an entry's path: {project_id_or_number}.{location_id}.{aspect_type_id}@{path} - "a_key": { # An aspect is a single piece of metadata describing an entry. + "a_key": { # Represents a single piece of metadata describing an entry or entry link. "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect. "createTime": "A String", # The time the aspect was created in the source system. "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc). @@ -394,7 +402,7 @@

Method Details

"entryLinks": [ # List of entry links that reference the specified entry. { # EntryLink represents a link between two Entries. "aspects": { # Optional. The aspects that are attached to the entry link. The format of the aspect key has to be the following: {project_id_or_number}.{location_id}.{aspect_type_id} Currently, only a single aspect of a Dataplex-owned Aspect Type is allowed. - "a_key": { # An aspect is a single piece of metadata describing an entry. + "a_key": { # Represents a single piece of metadata describing an entry or entry link. "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect. "createTime": "A String", # The time the aspect was created in the source system. "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc). @@ -440,6 +448,119 @@

Method Details

+
+ modifyEntry(name, body=None, x__xgafv=None) +
Modifies an entry using the permission on the source system.
+
+Args:
+  name: string, Required. The project to which the request should be attributed in the following form: projects/{project}/locations/{location}. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Modify Entry request using permissions in the source system.
+  "aspectKeys": [ # Optional. The aspect keys which the service should modify. It supports the following syntaxes: - matches an aspect of the given type and empty path. @path - matches an aspect of the given type and specified path. For example, to attach an aspect to a field that is specified by the schema aspect, the path should have the format Schema.. @* - matches aspects of the given type for all paths. *@path - matches aspects of all types on the given path.The service will not remove existing aspects matching the syntax unless delete_missing_aspects is set to true.If this field is left empty, the service treats it as specifying exactly those Aspects present in the request.
+    "A String",
+  ],
+  "deleteMissingAspects": True or False, # Optional. If set to true, any aspects not specified in the request will be deleted. The default is false.
+  "entry": { # An entry is a representation of a data resource that can be described by various metadata. # Required. The entry to modify.
+    "aspects": { # Optional. The aspects that are attached to the entry. Depending on how the aspect is attached to the entry, the format of the aspect key can be one of the following: If the aspect is attached directly to the entry: {project_id_or_number}.{location_id}.{aspect_type_id} If the aspect is attached to an entry's path: {project_id_or_number}.{location_id}.{aspect_type_id}@{path}
+      "a_key": { # Represents a single piece of metadata describing an entry or entry link.
+        "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect.
+          "createTime": "A String", # The time the aspect was created in the source system.
+          "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc).
+          "updateTime": "A String", # The time the aspect was last updated in the source system.
+        },
+        "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect.
+        "createTime": "A String", # Output only. The time when the Aspect was created.
+        "data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8).
+          "a_key": "", # Properties of the object.
+        },
+        "path": "A String", # Output only. The path in the entry under which the aspect is attached.
+        "updateTime": "A String", # Output only. The time when the Aspect was last updated.
+      },
+    },
+    "createTime": "A String", # Output only. The time when the entry was created in Dataplex Universal Catalog.
+    "entrySource": { # Information related to the source system of the data resource that is represented by the entry. # Optional. Information related to the source system of the data resource that is represented by the entry.
+      "ancestors": [ # Immutable. The entries representing the ancestors of the data resource in the source system.
+        { # Information about individual items in the hierarchy that is associated with the data resource.
+          "name": "A String", # Optional. The name of the ancestor resource.
+          "type": "A String", # Optional. The type of the ancestor resource.
+        },
+      ],
+      "createTime": "A String", # The time when the resource was created in the source system.
+      "description": "A String", # A description of the data resource. Maximum length is 2,000 characters.
+      "displayName": "A String", # A user-friendly display name. Maximum length is 500 characters.
+      "labels": { # User-defined labels. The maximum size of keys and values is 128 characters each.
+        "a_key": "A String",
+      },
+      "location": "A String", # Output only. Location of the resource in the source system. You can search the entry by this location. By default, this should match the location of the entry group containing this entry. A different value allows capturing the source location for data external to Google Cloud.
+      "platform": "A String", # The platform containing the source system. Maximum length is 64 characters.
+      "resource": "A String", # The name of the resource in the source system. Maximum length is 4,000 characters.
+      "system": "A String", # The name of the source system. Maximum length is 64 characters.
+      "updateTime": "A String", # The time when the resource was last updated in the source system. If the entry exists in the system and its EntrySource has update_time populated, further updates to the EntrySource of the entry must provide incremental updates to its update_time.
+    },
+    "entryType": "A String", # Required. Immutable. The relative resource name of the entry type that was used to create this entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id}.
+    "fullyQualifiedName": "A String", # Optional. A name for the entry that can be referenced by an external system. For more information, see Fully qualified names (https://cloud.google.com/data-catalog/docs/fully-qualified-names). The maximum size of the field is 4000 characters.
+    "name": "A String", # Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}.
+    "parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}.
+    "updateTime": "A String", # Output only. The time when the entry was last updated in Dataplex Universal Catalog.
+  },
+  "updateMask": "A String", # Optional. Mask of fields to update. To update Aspects, the update_mask must contain the value "aspects".If the update_mask is empty, the service will update all modifiable fields present in the request.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An entry is a representation of a data resource that can be described by various metadata.
+  "aspects": { # Optional. The aspects that are attached to the entry. Depending on how the aspect is attached to the entry, the format of the aspect key can be one of the following: If the aspect is attached directly to the entry: {project_id_or_number}.{location_id}.{aspect_type_id} If the aspect is attached to an entry's path: {project_id_or_number}.{location_id}.{aspect_type_id}@{path}
+    "a_key": { # Represents a single piece of metadata describing an entry or entry link.
+      "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect.
+        "createTime": "A String", # The time the aspect was created in the source system.
+        "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc).
+        "updateTime": "A String", # The time the aspect was last updated in the source system.
+      },
+      "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect.
+      "createTime": "A String", # Output only. The time when the Aspect was created.
+      "data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8).
+        "a_key": "", # Properties of the object.
+      },
+      "path": "A String", # Output only. The path in the entry under which the aspect is attached.
+      "updateTime": "A String", # Output only. The time when the Aspect was last updated.
+    },
+  },
+  "createTime": "A String", # Output only. The time when the entry was created in Dataplex Universal Catalog.
+  "entrySource": { # Information related to the source system of the data resource that is represented by the entry. # Optional. Information related to the source system of the data resource that is represented by the entry.
+    "ancestors": [ # Immutable. The entries representing the ancestors of the data resource in the source system.
+      { # Information about individual items in the hierarchy that is associated with the data resource.
+        "name": "A String", # Optional. The name of the ancestor resource.
+        "type": "A String", # Optional. The type of the ancestor resource.
+      },
+    ],
+    "createTime": "A String", # The time when the resource was created in the source system.
+    "description": "A String", # A description of the data resource. Maximum length is 2,000 characters.
+    "displayName": "A String", # A user-friendly display name. Maximum length is 500 characters.
+    "labels": { # User-defined labels. The maximum size of keys and values is 128 characters each.
+      "a_key": "A String",
+    },
+    "location": "A String", # Output only. Location of the resource in the source system. You can search the entry by this location. By default, this should match the location of the entry group containing this entry. A different value allows capturing the source location for data external to Google Cloud.
+    "platform": "A String", # The platform containing the source system. Maximum length is 64 characters.
+    "resource": "A String", # The name of the resource in the source system. Maximum length is 4,000 characters.
+    "system": "A String", # The name of the source system. Maximum length is 64 characters.
+    "updateTime": "A String", # The time when the resource was last updated in the source system. If the entry exists in the system and its EntrySource has update_time populated, further updates to the EntrySource of the entry must provide incremental updates to its update_time.
+  },
+  "entryType": "A String", # Required. Immutable. The relative resource name of the entry type that was used to create this entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id}.
+  "fullyQualifiedName": "A String", # Optional. A name for the entry that can be referenced by an external system. For more information, see Fully qualified names (https://cloud.google.com/data-catalog/docs/fully-qualified-names). The maximum size of the field is 4000 characters.
+  "name": "A String", # Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}.
+  "parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}.
+  "updateTime": "A String", # Output only. The time when the entry was last updated in Dataplex Universal Catalog.
+}
+
+
searchEntries(name, orderBy=None, pageSize=None, pageToken=None, query=None, scope=None, semanticSearch=None, x__xgafv=None)
Searches for Entries matching the given query and scope.
@@ -466,7 +587,7 @@ 

Method Details

{ # A single result of a SearchEntries request. "dataplexEntry": { # An entry is a representation of a data resource that can be described by various metadata. "aspects": { # Optional. The aspects that are attached to the entry. Depending on how the aspect is attached to the entry, the format of the aspect key can be one of the following: If the aspect is attached directly to the entry: {project_id_or_number}.{location_id}.{aspect_type_id} If the aspect is attached to an entry's path: {project_id_or_number}.{location_id}.{aspect_type_id}@{path} - "a_key": { # An aspect is a single piece of metadata describing an entry. + "a_key": { # Represents a single piece of metadata describing an entry or entry link. "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect. "createTime": "A String", # The time the aspect was created in the source system. "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc). @@ -511,7 +632,7 @@

Method Details

"snippets": { # Snippets for the entry, contains HTML-style highlighting for matched tokens, will be used in UI. # Snippets. "dataplexEntry": { # An entry is a representation of a data resource that can be described by various metadata. # Entry "aspects": { # Optional. The aspects that are attached to the entry. Depending on how the aspect is attached to the entry, the format of the aspect key can be one of the following: If the aspect is attached directly to the entry: {project_id_or_number}.{location_id}.{aspect_type_id} If the aspect is attached to an entry's path: {project_id_or_number}.{location_id}.{aspect_type_id}@{path} - "a_key": { # An aspect is a single piece of metadata describing an entry. + "a_key": { # Represents a single piece of metadata describing an entry or entry link. "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect. "createTime": "A String", # The time the aspect was created in the source system. "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc). diff --git a/docs/dyn/dataplex_v1.projects.locations.lakes.html b/docs/dyn/dataplex_v1.projects.locations.lakes.html index b486d0e58e..3ee0cfaaec 100644 --- a/docs/dyn/dataplex_v1.projects.locations.lakes.html +++ b/docs/dyn/dataplex_v1.projects.locations.lakes.html @@ -79,11 +79,6 @@

Instance Methods

Returns the actions Resource.

-

- environments() -

-

Returns the environments Resource.

-

tasks()

diff --git a/docs/dyn/dataproc_v1.projects.locations.batches.sparkApplications.html b/docs/dyn/dataproc_v1.projects.locations.batches.sparkApplications.html index 39486d934e..4b7637c169 100644 --- a/docs/dyn/dataproc_v1.projects.locations.batches.sparkApplications.html +++ b/docs/dyn/dataproc_v1.projects.locations.batches.sparkApplications.html @@ -342,6 +342,9 @@

Method Details

{ # Wrapper user to represent either a node or a cluster. "cluster": { # Represents a tree of spark plan. "desc": "A String", + "metadata": { # Optional. Additional metadata for the spark plan graph cluster. + "a_key": "A String", + }, "metrics": [ { # Metrics related to SQL execution. "accumulatorId": "A String", @@ -357,6 +360,9 @@

Method Details

}, "node": { # Represents a node in the spark plan tree. "desc": "A String", + "metadata": { # Optional. Additional metadata for the spark plan graph cluster. + "a_key": "A String", + }, "metrics": [ { # Metrics related to SQL execution. "accumulatorId": "A String", @@ -3520,6 +3526,9 @@

Method Details

{ # Wrapper user to represent either a node or a cluster. "cluster": { # Represents a tree of spark plan. "desc": "A String", + "metadata": { # Optional. Additional metadata for the spark plan graph cluster. + "a_key": "A String", + }, "metrics": [ { # Metrics related to SQL execution. "accumulatorId": "A String", @@ -3535,6 +3544,9 @@

Method Details

}, "node": { # Represents a node in the spark plan tree. "desc": "A String", + "metadata": { # Optional. Additional metadata for the spark plan graph cluster. + "a_key": "A String", + }, "metrics": [ { # Metrics related to SQL execution. "accumulatorId": "A String", diff --git a/docs/dyn/dataproc_v1.projects.locations.sessions.sparkApplications.html b/docs/dyn/dataproc_v1.projects.locations.sessions.sparkApplications.html index 0db3fc1386..cf478170c2 100644 --- a/docs/dyn/dataproc_v1.projects.locations.sessions.sparkApplications.html +++ b/docs/dyn/dataproc_v1.projects.locations.sessions.sparkApplications.html @@ -342,6 +342,9 @@

Method Details

{ # Wrapper user to represent either a node or a cluster. "cluster": { # Represents a tree of spark plan. "desc": "A String", + "metadata": { # Optional. Additional metadata for the spark plan graph cluster. + "a_key": "A String", + }, "metrics": [ { # Metrics related to SQL execution. "accumulatorId": "A String", @@ -357,6 +360,9 @@

Method Details

}, "node": { # Represents a node in the spark plan tree. "desc": "A String", + "metadata": { # Optional. Additional metadata for the spark plan graph cluster. + "a_key": "A String", + }, "metrics": [ { # Metrics related to SQL execution. "accumulatorId": "A String", @@ -3525,6 +3531,9 @@

Method Details

{ # Wrapper user to represent either a node or a cluster. "cluster": { # Represents a tree of spark plan. "desc": "A String", + "metadata": { # Optional. Additional metadata for the spark plan graph cluster. + "a_key": "A String", + }, "metrics": [ { # Metrics related to SQL execution. "accumulatorId": "A String", @@ -3540,6 +3549,9 @@

Method Details

}, "node": { # Represents a node in the spark plan tree. "desc": "A String", + "metadata": { # Optional. Additional metadata for the spark plan graph cluster. + "a_key": "A String", + }, "metrics": [ { # Metrics related to SQL execution. "accumulatorId": "A String", diff --git a/docs/dyn/dataproc_v1.projects.locations.workflowTemplates.html b/docs/dyn/dataproc_v1.projects.locations.workflowTemplates.html index b693548c14..08fecf0006 100644 --- a/docs/dyn/dataproc_v1.projects.locations.workflowTemplates.html +++ b/docs/dyn/dataproc_v1.projects.locations.workflowTemplates.html @@ -514,6 +514,7 @@

Method Details

"a_key": "A String", }, }, + "engine": "A String", # Optional. The cluster engine. "gceClusterConfig": { # Common config settings for resources of Compute Engine cluster instances, applicable to all instances in the cluster. # Optional. The shared Compute Engine config settings for all instances in a cluster. "autoZoneExcludeZoneUris": [ # Optional. An optional list of Compute Engine zones where the Dataproc cluster will not be located when Auto Zone is enabled. Only one of zone_uri or auto_zone_exclude_zone_uris can be set. If both are omitted, the service will pick a zone in the cluster Compute Engine region. If auto_zone_exclude_zone_uris is set and there is more than one non-excluded zone, the service will pick one of the non-excluded zones. Otherwise, cluster creation will fail with INVALID_ARGUMENT error.A full URL, partial URI, or short name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone] projects/[project_id]/zones/[zone] [zone] "A String", @@ -1272,6 +1273,7 @@

Method Details

"a_key": "A String", }, }, + "engine": "A String", # Optional. The cluster engine. "gceClusterConfig": { # Common config settings for resources of Compute Engine cluster instances, applicable to all instances in the cluster. # Optional. The shared Compute Engine config settings for all instances in a cluster. "autoZoneExcludeZoneUris": [ # Optional. An optional list of Compute Engine zones where the Dataproc cluster will not be located when Auto Zone is enabled. Only one of zone_uri or auto_zone_exclude_zone_uris can be set. If both are omitted, the service will pick a zone in the cluster Compute Engine region. If auto_zone_exclude_zone_uris is set and there is more than one non-excluded zone, the service will pick one of the non-excluded zones. Otherwise, cluster creation will fail with INVALID_ARGUMENT error.A full URL, partial URI, or short name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone] projects/[project_id]/zones/[zone] [zone] "A String", @@ -2057,6 +2059,7 @@

Method Details

"a_key": "A String", }, }, + "engine": "A String", # Optional. The cluster engine. "gceClusterConfig": { # Common config settings for resources of Compute Engine cluster instances, applicable to all instances in the cluster. # Optional. The shared Compute Engine config settings for all instances in a cluster. "autoZoneExcludeZoneUris": [ # Optional. An optional list of Compute Engine zones where the Dataproc cluster will not be located when Auto Zone is enabled. Only one of zone_uri or auto_zone_exclude_zone_uris can be set. If both are omitted, the service will pick a zone in the cluster Compute Engine region. If auto_zone_exclude_zone_uris is set and there is more than one non-excluded zone, the service will pick one of the non-excluded zones. Otherwise, cluster creation will fail with INVALID_ARGUMENT error.A full URL, partial URI, or short name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone] projects/[project_id]/zones/[zone] [zone] "A String", @@ -2906,6 +2909,7 @@

Method Details

"a_key": "A String", }, }, + "engine": "A String", # Optional. The cluster engine. "gceClusterConfig": { # Common config settings for resources of Compute Engine cluster instances, applicable to all instances in the cluster. # Optional. The shared Compute Engine config settings for all instances in a cluster. "autoZoneExcludeZoneUris": [ # Optional. An optional list of Compute Engine zones where the Dataproc cluster will not be located when Auto Zone is enabled. Only one of zone_uri or auto_zone_exclude_zone_uris can be set. If both are omitted, the service will pick a zone in the cluster Compute Engine region. If auto_zone_exclude_zone_uris is set and there is more than one non-excluded zone, the service will pick one of the non-excluded zones. Otherwise, cluster creation will fail with INVALID_ARGUMENT error.A full URL, partial URI, or short name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone] projects/[project_id]/zones/[zone] [zone] "A String", @@ -3705,6 +3709,7 @@

Method Details

"a_key": "A String", }, }, + "engine": "A String", # Optional. The cluster engine. "gceClusterConfig": { # Common config settings for resources of Compute Engine cluster instances, applicable to all instances in the cluster. # Optional. The shared Compute Engine config settings for all instances in a cluster. "autoZoneExcludeZoneUris": [ # Optional. An optional list of Compute Engine zones where the Dataproc cluster will not be located when Auto Zone is enabled. Only one of zone_uri or auto_zone_exclude_zone_uris can be set. If both are omitted, the service will pick a zone in the cluster Compute Engine region. If auto_zone_exclude_zone_uris is set and there is more than one non-excluded zone, the service will pick one of the non-excluded zones. Otherwise, cluster creation will fail with INVALID_ARGUMENT error.A full URL, partial URI, or short name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone] projects/[project_id]/zones/[zone] [zone] "A String", @@ -4572,6 +4577,7 @@

Method Details

"a_key": "A String", }, }, + "engine": "A String", # Optional. The cluster engine. "gceClusterConfig": { # Common config settings for resources of Compute Engine cluster instances, applicable to all instances in the cluster. # Optional. The shared Compute Engine config settings for all instances in a cluster. "autoZoneExcludeZoneUris": [ # Optional. An optional list of Compute Engine zones where the Dataproc cluster will not be located when Auto Zone is enabled. Only one of zone_uri or auto_zone_exclude_zone_uris can be set. If both are omitted, the service will pick a zone in the cluster Compute Engine region. If auto_zone_exclude_zone_uris is set and there is more than one non-excluded zone, the service will pick one of the non-excluded zones. Otherwise, cluster creation will fail with INVALID_ARGUMENT error.A full URL, partial URI, or short name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone] projects/[project_id]/zones/[zone] [zone] "A String", @@ -5330,6 +5336,7 @@

Method Details

"a_key": "A String", }, }, + "engine": "A String", # Optional. The cluster engine. "gceClusterConfig": { # Common config settings for resources of Compute Engine cluster instances, applicable to all instances in the cluster. # Optional. The shared Compute Engine config settings for all instances in a cluster. "autoZoneExcludeZoneUris": [ # Optional. An optional list of Compute Engine zones where the Dataproc cluster will not be located when Auto Zone is enabled. Only one of zone_uri or auto_zone_exclude_zone_uris can be set. If both are omitted, the service will pick a zone in the cluster Compute Engine region. If auto_zone_exclude_zone_uris is set and there is more than one non-excluded zone, the service will pick one of the non-excluded zones. Otherwise, cluster creation will fail with INVALID_ARGUMENT error.A full URL, partial URI, or short name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone] projects/[project_id]/zones/[zone] [zone] "A String", diff --git a/docs/dyn/dataproc_v1.projects.regions.clusters.html b/docs/dyn/dataproc_v1.projects.regions.clusters.html index bbd2c03446..57680aefde 100644 --- a/docs/dyn/dataproc_v1.projects.regions.clusters.html +++ b/docs/dyn/dataproc_v1.projects.regions.clusters.html @@ -258,6 +258,7 @@

Method Details

"a_key": "A String", }, }, + "engine": "A String", # Optional. The cluster engine. "gceClusterConfig": { # Common config settings for resources of Compute Engine cluster instances, applicable to all instances in the cluster. # Optional. The shared Compute Engine config settings for all instances in a cluster. "autoZoneExcludeZoneUris": [ # Optional. An optional list of Compute Engine zones where the Dataproc cluster will not be located when Auto Zone is enabled. Only one of zone_uri or auto_zone_exclude_zone_uris can be set. If both are omitted, the service will pick a zone in the cluster Compute Engine region. If auto_zone_exclude_zone_uris is set and there is more than one non-excluded zone, the service will pick one of the non-excluded zones. Otherwise, cluster creation will fail with INVALID_ARGUMENT error.A full URL, partial URI, or short name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone] projects/[project_id]/zones/[zone] [zone] "A String", @@ -965,6 +966,7 @@

Method Details

"a_key": "A String", }, }, + "engine": "A String", # Optional. The cluster engine. "gceClusterConfig": { # Common config settings for resources of Compute Engine cluster instances, applicable to all instances in the cluster. # Optional. The shared Compute Engine config settings for all instances in a cluster. "autoZoneExcludeZoneUris": [ # Optional. An optional list of Compute Engine zones where the Dataproc cluster will not be located when Auto Zone is enabled. Only one of zone_uri or auto_zone_exclude_zone_uris can be set. If both are omitted, the service will pick a zone in the cluster Compute Engine region. If auto_zone_exclude_zone_uris is set and there is more than one non-excluded zone, the service will pick one of the non-excluded zones. Otherwise, cluster creation will fail with INVALID_ARGUMENT error.A full URL, partial URI, or short name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone] projects/[project_id]/zones/[zone] [zone] "A String", @@ -1503,8 +1505,8 @@

Method Details

projectId: string, Required. The ID of the Google Cloud Platform project that the cluster belongs to. (required) region: string, Required. The Dataproc region in which to handle the request. (required) filter: string, Optional. A filter constraining the clusters to list. Filters are case-sensitive and have the following syntax:field = value AND field = value ...where field is one of status.state, clusterName, or labels.[KEY], and [KEY] is a label key. value can be * to match all values. status.state can be one of the following: ACTIVE, INACTIVE, CREATING, RUNNING, ERROR, DELETING, UPDATING, STOPPING, or STOPPED. ACTIVE contains the CREATING, UPDATING, and RUNNING states. INACTIVE contains the DELETING, ERROR, STOPPING, and STOPPED states. clusterName is the name of the cluster provided at creation time. Only the logical AND operator is supported; space-separated items are treated as having an implicit AND operator.Example filter:status.state = ACTIVE AND clusterName = mycluster AND labels.env = staging AND labels.starred = * - pageSize: integer, Optional. The standard List page size. - pageToken: string, Optional. The standard List page token. + pageSize: integer, Optional. The maximum number of clusters to return in each response. The service may return fewer than this value. If unspecified, the default value is 200. The maximum value is 1000. + pageToken: string, Optional. A page token received from a previous ListClusters call. Provide this token to retrieve the subsequent page. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -1633,6 +1635,7 @@

Method Details

"a_key": "A String", }, }, + "engine": "A String", # Optional. The cluster engine. "gceClusterConfig": { # Common config settings for resources of Compute Engine cluster instances, applicable to all instances in the cluster. # Optional. The shared Compute Engine config settings for all instances in a cluster. "autoZoneExcludeZoneUris": [ # Optional. An optional list of Compute Engine zones where the Dataproc cluster will not be located when Auto Zone is enabled. Only one of zone_uri or auto_zone_exclude_zone_uris can be set. If both are omitted, the service will pick a zone in the cluster Compute Engine region. If auto_zone_exclude_zone_uris is set and there is more than one non-excluded zone, the service will pick one of the non-excluded zones. Otherwise, cluster creation will fail with INVALID_ARGUMENT error.A full URL, partial URI, or short name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone] projects/[project_id]/zones/[zone] [zone] "A String", @@ -2221,6 +2224,7 @@

Method Details

"a_key": "A String", }, }, + "engine": "A String", # Optional. The cluster engine. "gceClusterConfig": { # Common config settings for resources of Compute Engine cluster instances, applicable to all instances in the cluster. # Optional. The shared Compute Engine config settings for all instances in a cluster. "autoZoneExcludeZoneUris": [ # Optional. An optional list of Compute Engine zones where the Dataproc cluster will not be located when Auto Zone is enabled. Only one of zone_uri or auto_zone_exclude_zone_uris can be set. If both are omitted, the service will pick a zone in the cluster Compute Engine region. If auto_zone_exclude_zone_uris is set and there is more than one non-excluded zone, the service will pick one of the non-excluded zones. Otherwise, cluster creation will fail with INVALID_ARGUMENT error.A full URL, partial URI, or short name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone] projects/[project_id]/zones/[zone] [zone] "A String", diff --git a/docs/dyn/dataproc_v1.projects.regions.workflowTemplates.html b/docs/dyn/dataproc_v1.projects.regions.workflowTemplates.html index 8278d76c3a..c79df6a575 100644 --- a/docs/dyn/dataproc_v1.projects.regions.workflowTemplates.html +++ b/docs/dyn/dataproc_v1.projects.regions.workflowTemplates.html @@ -514,6 +514,7 @@

Method Details

"a_key": "A String", }, }, + "engine": "A String", # Optional. The cluster engine. "gceClusterConfig": { # Common config settings for resources of Compute Engine cluster instances, applicable to all instances in the cluster. # Optional. The shared Compute Engine config settings for all instances in a cluster. "autoZoneExcludeZoneUris": [ # Optional. An optional list of Compute Engine zones where the Dataproc cluster will not be located when Auto Zone is enabled. Only one of zone_uri or auto_zone_exclude_zone_uris can be set. If both are omitted, the service will pick a zone in the cluster Compute Engine region. If auto_zone_exclude_zone_uris is set and there is more than one non-excluded zone, the service will pick one of the non-excluded zones. Otherwise, cluster creation will fail with INVALID_ARGUMENT error.A full URL, partial URI, or short name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone] projects/[project_id]/zones/[zone] [zone] "A String", @@ -1272,6 +1273,7 @@

Method Details

"a_key": "A String", }, }, + "engine": "A String", # Optional. The cluster engine. "gceClusterConfig": { # Common config settings for resources of Compute Engine cluster instances, applicable to all instances in the cluster. # Optional. The shared Compute Engine config settings for all instances in a cluster. "autoZoneExcludeZoneUris": [ # Optional. An optional list of Compute Engine zones where the Dataproc cluster will not be located when Auto Zone is enabled. Only one of zone_uri or auto_zone_exclude_zone_uris can be set. If both are omitted, the service will pick a zone in the cluster Compute Engine region. If auto_zone_exclude_zone_uris is set and there is more than one non-excluded zone, the service will pick one of the non-excluded zones. Otherwise, cluster creation will fail with INVALID_ARGUMENT error.A full URL, partial URI, or short name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone] projects/[project_id]/zones/[zone] [zone] "A String", @@ -2057,6 +2059,7 @@

Method Details

"a_key": "A String", }, }, + "engine": "A String", # Optional. The cluster engine. "gceClusterConfig": { # Common config settings for resources of Compute Engine cluster instances, applicable to all instances in the cluster. # Optional. The shared Compute Engine config settings for all instances in a cluster. "autoZoneExcludeZoneUris": [ # Optional. An optional list of Compute Engine zones where the Dataproc cluster will not be located when Auto Zone is enabled. Only one of zone_uri or auto_zone_exclude_zone_uris can be set. If both are omitted, the service will pick a zone in the cluster Compute Engine region. If auto_zone_exclude_zone_uris is set and there is more than one non-excluded zone, the service will pick one of the non-excluded zones. Otherwise, cluster creation will fail with INVALID_ARGUMENT error.A full URL, partial URI, or short name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone] projects/[project_id]/zones/[zone] [zone] "A String", @@ -2906,6 +2909,7 @@

Method Details

"a_key": "A String", }, }, + "engine": "A String", # Optional. The cluster engine. "gceClusterConfig": { # Common config settings for resources of Compute Engine cluster instances, applicable to all instances in the cluster. # Optional. The shared Compute Engine config settings for all instances in a cluster. "autoZoneExcludeZoneUris": [ # Optional. An optional list of Compute Engine zones where the Dataproc cluster will not be located when Auto Zone is enabled. Only one of zone_uri or auto_zone_exclude_zone_uris can be set. If both are omitted, the service will pick a zone in the cluster Compute Engine region. If auto_zone_exclude_zone_uris is set and there is more than one non-excluded zone, the service will pick one of the non-excluded zones. Otherwise, cluster creation will fail with INVALID_ARGUMENT error.A full URL, partial URI, or short name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone] projects/[project_id]/zones/[zone] [zone] "A String", @@ -3705,6 +3709,7 @@

Method Details

"a_key": "A String", }, }, + "engine": "A String", # Optional. The cluster engine. "gceClusterConfig": { # Common config settings for resources of Compute Engine cluster instances, applicable to all instances in the cluster. # Optional. The shared Compute Engine config settings for all instances in a cluster. "autoZoneExcludeZoneUris": [ # Optional. An optional list of Compute Engine zones where the Dataproc cluster will not be located when Auto Zone is enabled. Only one of zone_uri or auto_zone_exclude_zone_uris can be set. If both are omitted, the service will pick a zone in the cluster Compute Engine region. If auto_zone_exclude_zone_uris is set and there is more than one non-excluded zone, the service will pick one of the non-excluded zones. Otherwise, cluster creation will fail with INVALID_ARGUMENT error.A full URL, partial URI, or short name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone] projects/[project_id]/zones/[zone] [zone] "A String", @@ -4572,6 +4577,7 @@

Method Details

"a_key": "A String", }, }, + "engine": "A String", # Optional. The cluster engine. "gceClusterConfig": { # Common config settings for resources of Compute Engine cluster instances, applicable to all instances in the cluster. # Optional. The shared Compute Engine config settings for all instances in a cluster. "autoZoneExcludeZoneUris": [ # Optional. An optional list of Compute Engine zones where the Dataproc cluster will not be located when Auto Zone is enabled. Only one of zone_uri or auto_zone_exclude_zone_uris can be set. If both are omitted, the service will pick a zone in the cluster Compute Engine region. If auto_zone_exclude_zone_uris is set and there is more than one non-excluded zone, the service will pick one of the non-excluded zones. Otherwise, cluster creation will fail with INVALID_ARGUMENT error.A full URL, partial URI, or short name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone] projects/[project_id]/zones/[zone] [zone] "A String", @@ -5330,6 +5336,7 @@

Method Details

"a_key": "A String", }, }, + "engine": "A String", # Optional. The cluster engine. "gceClusterConfig": { # Common config settings for resources of Compute Engine cluster instances, applicable to all instances in the cluster. # Optional. The shared Compute Engine config settings for all instances in a cluster. "autoZoneExcludeZoneUris": [ # Optional. An optional list of Compute Engine zones where the Dataproc cluster will not be located when Auto Zone is enabled. Only one of zone_uri or auto_zone_exclude_zone_uris can be set. If both are omitted, the service will pick a zone in the cluster Compute Engine region. If auto_zone_exclude_zone_uris is set and there is more than one non-excluded zone, the service will pick one of the non-excluded zones. Otherwise, cluster creation will fail with INVALID_ARGUMENT error.A full URL, partial URI, or short name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone] projects/[project_id]/zones/[zone] [zone] "A String", diff --git a/docs/dyn/displayvideo_v2.advertisers.insertionOrders.html b/docs/dyn/displayvideo_v2.advertisers.insertionOrders.html index eab46f6845..b7351a30c2 100644 --- a/docs/dyn/displayvideo_v2.advertisers.insertionOrders.html +++ b/docs/dyn/displayvideo_v2.advertisers.insertionOrders.html @@ -117,7 +117,7 @@

Method Details

"effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field. "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value. "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level. - "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPC` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. }, "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. @@ -216,7 +216,7 @@

Method Details

"effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field. "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value. "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level. - "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPC` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. }, "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. @@ -342,7 +342,7 @@

Method Details

"effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field. "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value. "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level. - "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPC` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. }, "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. @@ -454,7 +454,7 @@

Method Details

"effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field. "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value. "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level. - "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPC` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. }, "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. @@ -573,7 +573,7 @@

Method Details

"effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field. "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value. "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level. - "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPC` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. }, "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. @@ -673,7 +673,7 @@

Method Details

"effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field. "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value. "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level. - "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPC` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. }, "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. diff --git a/docs/dyn/displayvideo_v2.advertisers.lineItems.html b/docs/dyn/displayvideo_v2.advertisers.lineItems.html index 307f516c36..56f345d625 100644 --- a/docs/dyn/displayvideo_v2.advertisers.lineItems.html +++ b/docs/dyn/displayvideo_v2.advertisers.lineItems.html @@ -808,7 +808,7 @@

Method Details

"effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field. "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value. "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level. - "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPC` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. }, "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. @@ -1077,7 +1077,7 @@

Method Details

"effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field. "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value. "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level. - "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPC` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. }, "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. @@ -1306,7 +1306,7 @@

Method Details

"effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field. "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value. "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level. - "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPC` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. }, "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. @@ -1590,7 +1590,7 @@

Method Details

"effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field. "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value. "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level. - "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPC` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. }, "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. @@ -1832,7 +1832,7 @@

Method Details

"effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field. "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value. "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level. - "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPC` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. }, "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. @@ -2081,7 +2081,7 @@

Method Details

"effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field. "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value. "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level. - "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPC` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. }, "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. @@ -2311,7 +2311,7 @@

Method Details

"effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field. "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value. "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level. - "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPC` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. }, "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. diff --git a/docs/dyn/displayvideo_v3.advertisers.adGroupAds.html b/docs/dyn/displayvideo_v3.advertisers.adGroupAds.html index 024e7887b6..f9aaba6982 100644 --- a/docs/dyn/displayvideo_v3.advertisers.adGroupAds.html +++ b/docs/dyn/displayvideo_v3.advertisers.adGroupAds.html @@ -286,6 +286,11 @@

Method Details

}, }, }, + "dcmTrackingInfo": { # Details on the DCM tracking. # Optional. The DCM tracking ad info. Only valid for Demand Gen ads. To remove the DCM tracking ad info, please leave this field empty. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. + "creativeId": "A String", # Required. The DCM creative id. + "placementId": "A String", # Required. The DCM placement id. + "trackingAdId": "A String", # Required. The DCM tracking ad id. + }, "demandGenCarouselAd": { # Details for a Demand Gen carousel ad. # Details of a [Demand Gen carousel ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#CarouselAd). "businessName": "A String", # Required. The business name shown on the ad. "cards": [ # Required. The list of cards shown on the ad. @@ -794,6 +799,11 @@

Method Details

}, }, }, + "dcmTrackingInfo": { # Details on the DCM tracking. # Optional. The DCM tracking ad info. Only valid for Demand Gen ads. To remove the DCM tracking ad info, please leave this field empty. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. + "creativeId": "A String", # Required. The DCM creative id. + "placementId": "A String", # Required. The DCM placement id. + "trackingAdId": "A String", # Required. The DCM tracking ad id. + }, "demandGenCarouselAd": { # Details for a Demand Gen carousel ad. # Details of a [Demand Gen carousel ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#CarouselAd). "businessName": "A String", # Required. The business name shown on the ad. "cards": [ # Required. The list of cards shown on the ad. @@ -1329,6 +1339,11 @@

Method Details

}, }, }, + "dcmTrackingInfo": { # Details on the DCM tracking. # Optional. The DCM tracking ad info. Only valid for Demand Gen ads. To remove the DCM tracking ad info, please leave this field empty. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. + "creativeId": "A String", # Required. The DCM creative id. + "placementId": "A String", # Required. The DCM placement id. + "trackingAdId": "A String", # Required. The DCM tracking ad id. + }, "demandGenCarouselAd": { # Details for a Demand Gen carousel ad. # Details of a [Demand Gen carousel ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#CarouselAd). "businessName": "A String", # Required. The business name shown on the ad. "cards": [ # Required. The list of cards shown on the ad. @@ -1850,6 +1865,11 @@

Method Details

}, }, }, + "dcmTrackingInfo": { # Details on the DCM tracking. # Optional. The DCM tracking ad info. Only valid for Demand Gen ads. To remove the DCM tracking ad info, please leave this field empty. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. + "creativeId": "A String", # Required. The DCM creative id. + "placementId": "A String", # Required. The DCM placement id. + "trackingAdId": "A String", # Required. The DCM tracking ad id. + }, "demandGenCarouselAd": { # Details for a Demand Gen carousel ad. # Details of a [Demand Gen carousel ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#CarouselAd). "businessName": "A String", # Required. The business name shown on the ad. "cards": [ # Required. The list of cards shown on the ad. @@ -2378,6 +2398,11 @@

Method Details

}, }, }, + "dcmTrackingInfo": { # Details on the DCM tracking. # Optional. The DCM tracking ad info. Only valid for Demand Gen ads. To remove the DCM tracking ad info, please leave this field empty. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. + "creativeId": "A String", # Required. The DCM creative id. + "placementId": "A String", # Required. The DCM placement id. + "trackingAdId": "A String", # Required. The DCM tracking ad id. + }, "demandGenCarouselAd": { # Details for a Demand Gen carousel ad. # Details of a [Demand Gen carousel ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#CarouselAd). "businessName": "A String", # Required. The business name shown on the ad. "cards": [ # Required. The list of cards shown on the ad. @@ -2887,6 +2912,11 @@

Method Details

}, }, }, + "dcmTrackingInfo": { # Details on the DCM tracking. # Optional. The DCM tracking ad info. Only valid for Demand Gen ads. To remove the DCM tracking ad info, please leave this field empty. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. + "creativeId": "A String", # Required. The DCM creative id. + "placementId": "A String", # Required. The DCM placement id. + "trackingAdId": "A String", # Required. The DCM tracking ad id. + }, "demandGenCarouselAd": { # Details for a Demand Gen carousel ad. # Details of a [Demand Gen carousel ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#CarouselAd). "businessName": "A String", # Required. The business name shown on the ad. "cards": [ # Required. The list of cards shown on the ad. diff --git a/docs/dyn/displayvideo_v3.advertisers.adGroups.html b/docs/dyn/displayvideo_v3.advertisers.adGroups.html index 810d0c3012..cae6de54e2 100644 --- a/docs/dyn/displayvideo_v3.advertisers.adGroups.html +++ b/docs/dyn/displayvideo_v3.advertisers.adGroups.html @@ -902,7 +902,7 @@

Method Details

"effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field. "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value. "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level. - "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPC` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. }, "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. @@ -979,7 +979,7 @@

Method Details

"effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field. "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value. "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level. - "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPC` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. }, "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. @@ -1083,7 +1083,7 @@

Method Details

"effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field. "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value. "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level. - "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPC` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. }, "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. @@ -1173,7 +1173,7 @@

Method Details

"effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field. "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value. "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level. - "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPC` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. }, "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. @@ -1270,7 +1270,7 @@

Method Details

"effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field. "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value. "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level. - "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPC` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. }, "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. @@ -1348,7 +1348,7 @@

Method Details

"effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field. "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value. "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level. - "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPC` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. }, "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. diff --git a/docs/dyn/displayvideo_v3.advertisers.insertionOrders.html b/docs/dyn/displayvideo_v3.advertisers.insertionOrders.html index 17a9c320a2..75bbbf9415 100644 --- a/docs/dyn/displayvideo_v3.advertisers.insertionOrders.html +++ b/docs/dyn/displayvideo_v3.advertisers.insertionOrders.html @@ -117,7 +117,7 @@

Method Details

"effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field. "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value. "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level. - "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPC` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. }, "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. @@ -223,7 +223,7 @@

Method Details

"effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field. "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value. "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level. - "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPC` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. }, "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. @@ -356,7 +356,7 @@

Method Details

"effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field. "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value. "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level. - "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPC` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. }, "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. @@ -475,7 +475,7 @@

Method Details

"effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field. "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value. "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level. - "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPC` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. }, "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. @@ -601,7 +601,7 @@

Method Details

"effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field. "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value. "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level. - "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPC` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. }, "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. @@ -708,7 +708,7 @@

Method Details

"effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field. "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value. "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level. - "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPC` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. }, "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. diff --git a/docs/dyn/displayvideo_v3.advertisers.lineItems.html b/docs/dyn/displayvideo_v3.advertisers.lineItems.html index c20faf6ce8..6d64cf522f 100644 --- a/docs/dyn/displayvideo_v3.advertisers.lineItems.html +++ b/docs/dyn/displayvideo_v3.advertisers.lineItems.html @@ -894,7 +894,7 @@

Method Details

"effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field. "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value. "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level. - "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPC` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. }, "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. @@ -1163,7 +1163,7 @@

Method Details

"effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field. "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value. "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level. - "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPC` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. }, "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. @@ -1392,7 +1392,7 @@

Method Details

"effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field. "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value. "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level. - "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPC` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. }, "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. @@ -1676,7 +1676,7 @@

Method Details

"effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field. "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value. "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level. - "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPC` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. }, "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. @@ -1918,7 +1918,7 @@

Method Details

"effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field. "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value. "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level. - "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPC` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. }, "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. @@ -2167,7 +2167,7 @@

Method Details

"effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field. "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value. "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level. - "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPC` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. }, "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. @@ -2397,7 +2397,7 @@

Method Details

"effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field. "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value. "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level. - "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPC` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. }, "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. diff --git a/docs/dyn/displayvideo_v4.advertisers.adGroupAds.html b/docs/dyn/displayvideo_v4.advertisers.adGroupAds.html index efd432f271..ec6c64ac2f 100644 --- a/docs/dyn/displayvideo_v4.advertisers.adGroupAds.html +++ b/docs/dyn/displayvideo_v4.advertisers.adGroupAds.html @@ -286,6 +286,11 @@

Method Details

}, }, }, + "dcmTrackingInfo": { # Details on the DCM tracking. # Optional. The DCM tracking ad info. Only valid for Demand Gen ads. To remove the DCM tracking ad info, please leave this field empty. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. + "creativeId": "A String", # Required. The DCM creative id. + "placementId": "A String", # Required. The DCM placement id. + "trackingAdId": "A String", # Required. The DCM tracking ad id. + }, "demandGenCarouselAd": { # Details for a Demand Gen carousel ad. # Details of a [Demand Gen carousel ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#CarouselAd). "businessName": "A String", # Required. The business name shown on the ad. "cards": [ # Required. The list of cards shown on the ad. @@ -794,6 +799,11 @@

Method Details

}, }, }, + "dcmTrackingInfo": { # Details on the DCM tracking. # Optional. The DCM tracking ad info. Only valid for Demand Gen ads. To remove the DCM tracking ad info, please leave this field empty. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. + "creativeId": "A String", # Required. The DCM creative id. + "placementId": "A String", # Required. The DCM placement id. + "trackingAdId": "A String", # Required. The DCM tracking ad id. + }, "demandGenCarouselAd": { # Details for a Demand Gen carousel ad. # Details of a [Demand Gen carousel ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#CarouselAd). "businessName": "A String", # Required. The business name shown on the ad. "cards": [ # Required. The list of cards shown on the ad. @@ -1329,6 +1339,11 @@

Method Details

}, }, }, + "dcmTrackingInfo": { # Details on the DCM tracking. # Optional. The DCM tracking ad info. Only valid for Demand Gen ads. To remove the DCM tracking ad info, please leave this field empty. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. + "creativeId": "A String", # Required. The DCM creative id. + "placementId": "A String", # Required. The DCM placement id. + "trackingAdId": "A String", # Required. The DCM tracking ad id. + }, "demandGenCarouselAd": { # Details for a Demand Gen carousel ad. # Details of a [Demand Gen carousel ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#CarouselAd). "businessName": "A String", # Required. The business name shown on the ad. "cards": [ # Required. The list of cards shown on the ad. @@ -1850,6 +1865,11 @@

Method Details

}, }, }, + "dcmTrackingInfo": { # Details on the DCM tracking. # Optional. The DCM tracking ad info. Only valid for Demand Gen ads. To remove the DCM tracking ad info, please leave this field empty. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. + "creativeId": "A String", # Required. The DCM creative id. + "placementId": "A String", # Required. The DCM placement id. + "trackingAdId": "A String", # Required. The DCM tracking ad id. + }, "demandGenCarouselAd": { # Details for a Demand Gen carousel ad. # Details of a [Demand Gen carousel ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#CarouselAd). "businessName": "A String", # Required. The business name shown on the ad. "cards": [ # Required. The list of cards shown on the ad. @@ -2378,6 +2398,11 @@

Method Details

}, }, }, + "dcmTrackingInfo": { # Details on the DCM tracking. # Optional. The DCM tracking ad info. Only valid for Demand Gen ads. To remove the DCM tracking ad info, please leave this field empty. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. + "creativeId": "A String", # Required. The DCM creative id. + "placementId": "A String", # Required. The DCM placement id. + "trackingAdId": "A String", # Required. The DCM tracking ad id. + }, "demandGenCarouselAd": { # Details for a Demand Gen carousel ad. # Details of a [Demand Gen carousel ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#CarouselAd). "businessName": "A String", # Required. The business name shown on the ad. "cards": [ # Required. The list of cards shown on the ad. @@ -2887,6 +2912,11 @@

Method Details

}, }, }, + "dcmTrackingInfo": { # Details on the DCM tracking. # Optional. The DCM tracking ad info. Only valid for Demand Gen ads. To remove the DCM tracking ad info, please leave this field empty. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. + "creativeId": "A String", # Required. The DCM creative id. + "placementId": "A String", # Required. The DCM placement id. + "trackingAdId": "A String", # Required. The DCM tracking ad id. + }, "demandGenCarouselAd": { # Details for a Demand Gen carousel ad. # Details of a [Demand Gen carousel ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#CarouselAd). "businessName": "A String", # Required. The business name shown on the ad. "cards": [ # Required. The list of cards shown on the ad. diff --git a/docs/dyn/displayvideo_v4.advertisers.adGroups.html b/docs/dyn/displayvideo_v4.advertisers.adGroups.html index e174af0387..bf4a289068 100644 --- a/docs/dyn/displayvideo_v4.advertisers.adGroups.html +++ b/docs/dyn/displayvideo_v4.advertisers.adGroups.html @@ -907,7 +907,7 @@

Method Details

"effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field. "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value. "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level. - "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPC` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. }, "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. @@ -984,7 +984,7 @@

Method Details

"effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field. "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value. "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level. - "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPC` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. }, "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. @@ -1088,7 +1088,7 @@

Method Details

"effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field. "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value. "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level. - "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPC` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. }, "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. @@ -1178,7 +1178,7 @@

Method Details

"effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field. "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value. "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level. - "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPC` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. }, "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. @@ -1275,7 +1275,7 @@

Method Details

"effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field. "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value. "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level. - "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPC` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. }, "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. @@ -1353,7 +1353,7 @@

Method Details

"effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field. "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value. "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level. - "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPC` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. }, "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. diff --git a/docs/dyn/displayvideo_v4.advertisers.insertionOrders.html b/docs/dyn/displayvideo_v4.advertisers.insertionOrders.html index b22c93d1de..13f7039e3f 100644 --- a/docs/dyn/displayvideo_v4.advertisers.insertionOrders.html +++ b/docs/dyn/displayvideo_v4.advertisers.insertionOrders.html @@ -117,7 +117,7 @@

Method Details

"effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field. "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value. "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level. - "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPC` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. }, "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. @@ -223,7 +223,7 @@

Method Details

"effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field. "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value. "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level. - "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPC` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. }, "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. @@ -356,7 +356,7 @@

Method Details

"effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field. "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value. "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level. - "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPC` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. }, "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. @@ -475,7 +475,7 @@

Method Details

"effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field. "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value. "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level. - "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPC` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. }, "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. @@ -601,7 +601,7 @@

Method Details

"effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field. "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value. "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level. - "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPC` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. }, "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. @@ -708,7 +708,7 @@

Method Details

"effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field. "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value. "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level. - "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPC` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. }, "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. diff --git a/docs/dyn/displayvideo_v4.advertisers.lineItems.html b/docs/dyn/displayvideo_v4.advertisers.lineItems.html index 6c537a0d74..b387cdddbc 100644 --- a/docs/dyn/displayvideo_v4.advertisers.lineItems.html +++ b/docs/dyn/displayvideo_v4.advertisers.lineItems.html @@ -899,7 +899,7 @@

Method Details

"effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field. "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value. "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level. - "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPC` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. }, "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. @@ -1168,7 +1168,7 @@

Method Details

"effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field. "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value. "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level. - "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPC` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. }, "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. @@ -1397,7 +1397,7 @@

Method Details

"effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field. "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value. "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level. - "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPC` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. }, "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. @@ -1681,7 +1681,7 @@

Method Details

"effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field. "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value. "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level. - "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPC` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. }, "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. @@ -1923,7 +1923,7 @@

Method Details

"effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field. "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value. "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level. - "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPC` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. }, "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. @@ -2172,7 +2172,7 @@

Method Details

"effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field. "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value. "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level. - "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPC` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. }, "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. @@ -2402,7 +2402,7 @@

Method Details

"effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field. "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value. "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level. - "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPC` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. }, "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. diff --git a/docs/dyn/documentai_v1.projects.locations.html b/docs/dyn/documentai_v1.projects.locations.html index 8e9ed8e3f7..430803a95b 100644 --- a/docs/dyn/documentai_v1.projects.locations.html +++ b/docs/dyn/documentai_v1.projects.locations.html @@ -105,7 +105,7 @@

Instance Methods

Gets information about a location.

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

-

Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.

+

Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.

list_next()

Retrieves the next page of results.

@@ -179,7 +179,7 @@

Method Details

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
+  
Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
diff --git a/docs/dyn/documentai_v1beta3.projects.locations.html b/docs/dyn/documentai_v1beta3.projects.locations.html
index 4852a12085..075ba492f2 100644
--- a/docs/dyn/documentai_v1beta3.projects.locations.html
+++ b/docs/dyn/documentai_v1beta3.projects.locations.html
@@ -105,7 +105,7 @@ 

Instance Methods

Gets information about a location.

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

-

Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.

+

Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.

list_next()

Retrieves the next page of results.

@@ -179,7 +179,7 @@

Method Details

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
+  
Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
diff --git a/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html b/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html
index 245531ae3f..a05a2b5366 100644
--- a/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html
+++ b/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html
@@ -1296,6 +1296,8 @@ 

Method Details

"retrievedContext": { # Context retrieved from a data source to ground the model's response. This is used when a retrieval tool fetches information from a user-provided corpus or a public dataset. # A grounding chunk from a data source retrieved by a retrieval tool, such as Vertex AI Search. See the `RetrievedContext` message for details "documentName": "A String", # Output only. The full resource name of the referenced Vertex AI Search document. This is used to identify the specific document that was retrieved. The format is `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. "ragChunk": { # A RagChunk includes the content of a chunk of a RagFile, and associated metadata. # Additional context for a Retrieval-Augmented Generation (RAG) retrieval result. This is populated only when the RAG retrieval tool is used. + "chunkId": "A String", # The ID of the chunk. + "fileId": "A String", # The ID of the file that the chunk belongs to. "pageSpan": { # Represents where the chunk starts and ends in the document. # If populated, represents where the chunk starts and ends in the document. "firstPage": 42, # Page where chunk starts in the document. Inclusive. 1-indexed. "lastPage": 42, # Page where chunk ends in the document. Inclusive. 1-indexed. @@ -2126,6 +2128,8 @@

Method Details

"retrievedContext": { # Context retrieved from a data source to ground the model's response. This is used when a retrieval tool fetches information from a user-provided corpus or a public dataset. # A grounding chunk from a data source retrieved by a retrieval tool, such as Vertex AI Search. See the `RetrievedContext` message for details "documentName": "A String", # Output only. The full resource name of the referenced Vertex AI Search document. This is used to identify the specific document that was retrieved. The format is `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. "ragChunk": { # A RagChunk includes the content of a chunk of a RagFile, and associated metadata. # Additional context for a Retrieval-Augmented Generation (RAG) retrieval result. This is populated only when the RAG retrieval tool is used. + "chunkId": "A String", # The ID of the chunk. + "fileId": "A String", # The ID of the file that the chunk belongs to. "pageSpan": { # Represents where the chunk starts and ends in the document. # If populated, represents where the chunk starts and ends in the document. "firstPage": 42, # Page where chunk starts in the document. Inclusive. 1-indexed. "lastPage": 42, # Page where chunk ends in the document. Inclusive. 1-indexed. diff --git a/docs/dyn/firestore_v1.projects.databases.collectionGroups.fields.html b/docs/dyn/firestore_v1.projects.databases.collectionGroups.fields.html index fd7aea1e16..e4902deeb2 100644 --- a/docs/dyn/firestore_v1.projects.databases.collectionGroups.fields.html +++ b/docs/dyn/firestore_v1.projects.databases.collectionGroups.fields.html @@ -121,6 +121,22 @@

Method Details

"arrayConfig": "A String", # Indicates that this field supports operations on `array_value`s. "fieldPath": "A String", # Can be __name__. For single field indexes, this must match the name of the field or may be omitted. "order": "A String", # Indicates that this field supports ordering by the specified order or comparing using =, !=, <, <=, >, >=. + "searchConfig": { # The configuration for how to index a field for search. # Indicates that this field supports search operations. This field is only currently supported for indexes with MONGODB_COMPATIBLE_API ApiScope. + "geoSpec": { # The specification for how to build a geo search index for a field. # Optional. The specification for building a geo search index for a field. + "geoJsonIndexingDisabled": True or False, # Optional. Disables geoJSON indexing for the field. By default, geoJSON points are indexed. + }, + "numberSpec": { # The specification for how to build a number search index for a field. # Optional. The specification for building a number search index for a field. + "indexType": "A String", # Required. How to index the number field value. + }, + "textSpec": { # The specification for how to build a text search index for a field. # Optional. The specification for building a text search index for a field. + "indexSpecs": [ # Required. Specifications for how the field should be indexed. Repeated so that the field can be indexed in multiple ways. + { # Specification of how the field should be indexed for search text indexes. + "indexType": "A String", # Required. How to index the text field value. + "matchType": "A String", # Required. How to match the text field value. + }, + ], + }, + }, "vectorConfig": { # The index configuration to support vector search operations # Indicates that this field supports nearest neighbor and distance operations on vector. "dimension": 42, # Required. The vector dimension this configuration applies to. The resulting index will only include vectors of this dimension, and can be used for vector search with the same dimension. "flat": { # An index that stores vectors in a flat data structure, and supports exhaustive search. # Indicates the vector index is a flat index. @@ -131,6 +147,13 @@

Method Details

"multikey": True or False, # Optional. Whether the index is multikey. By default, the index is not multikey. For non-multikey indexes, none of the paths in the index definition reach or traverse an array, except via an explicit array index. For multikey indexes, at most one of the paths in the index definition reach or traverse an array, except via an explicit array index. Violations will result in errors. Note this field only applies to index with MONGODB_COMPATIBLE_API ApiScope. "name": "A String", # Output only. A server defined name for this index. The form of this name for composite indexes will be: `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{composite_index_id}` For single field indexes, this field will be empty. "queryScope": "A String", # Indexes with a collection query scope specified allow queries against a collection that is the child of a specific document, specified at query time, and that has the same collection ID. Indexes with a collection group query scope specified allow queries against all collections descended from a specific document, specified at query time, and that have the same collection ID as this index. + "searchIndexOptions": { # Options for search indexes at the definition level. # Optional. Options for search indexes that are at the index definition level. This field is only currently supported for indexes with MONGODB_COMPATIBLE_API ApiScope. + "customPartitionFieldPaths": [ # Optional. Custom partition fields to use for the search index. If unspecified, all indexed fields will be in the same default partition. If a search index is created specifying custom partition fields, all search queries using that index will be required to filter on the partition. For indexes with MONGODB_COMPATIBLE_API ApiScope: This must refer to a top level field name. + "A String", + ], + "textLanguage": "A String", # Optional. The language to use for text search indexes. Used as the default language if not overridden at the document level by specifying the `text_language_override_field`. The language is specified as a BCP 47 language code. For indexes with MONGODB_COMPATIBLE_API ApiScope: If unspecified, the default language is English. For indexes with `ANY_API` ApiScope: If unspecified, the default behavior is autodetect. + "textLanguageOverrideFieldPath": "A String", # Optional. The field in the document that specifies which language to use for that specific document. For indexes with MONGODB_COMPATIBLE_API ApiScope: if unspecified, the language is taken from the "language" field if it exists or from `text_language` if it does not. + }, "shardCount": 42, # Optional. The number of shards for the index. "state": "A String", # Output only. The serving state of the index. "unique": True or False, # Optional. Whether it is an unique index. Unique index ensures all values for the indexed field(s) are unique across documents. @@ -140,7 +163,8 @@

Method Details

"usesAncestorConfig": True or False, # Output only. When true, the `Field`'s index configuration is set from the configuration specified by the `ancestor_field`. When false, the `Field`'s index configuration is defined explicitly. }, "name": "A String", # Required. A field name of the form: `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}` A field path can be a simple field name, e.g. `address` or a path to fields within `map_value` , e.g. `address.city`, or a special field path. The only valid special field is `*`, which represents any field. Field paths can be quoted using `` ` `` (backtick). The only character that must be escaped within a quoted field path is the backtick character itself, escaped using a backslash. Special characters in field paths that must be quoted include: `*`, `.`, `` ` `` (backtick), `[`, `]`, as well as any ascii symbolic characters. Examples: `` `address.city` `` represents a field named `address.city`, not the map key `city` in the field `address`. `` `*` `` represents a field named `*`, not any field. A special `Field` contains the default indexing settings for all fields. This field's resource name is: `projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*` Indexes defined on this `Field` will be applied to all fields which do not have their own `Field` index configuration. - "ttlConfig": { # The TTL (time-to-live) configuration for documents that have this `Field` set. Storing a timestamp value into a TTL-enabled field will be treated as the document's absolute expiration time. For Enterprise edition databases, the timestamp value may also be stored in an array value in the TTL-enabled field. Timestamp values in the past indicate that the document is eligible for immediate expiration. Using any other data type or leaving the field absent will disable expiration for the individual document. # The TTL configuration for this `Field`. Setting or unsetting this will enable or disable the TTL for documents that have this `Field`. + "ttlConfig": { # The TTL (time-to-live) configuration for documents that have this `Field` set. A timestamp stored in a TTL-enabled field will be used to determine the expiration time of the document. The expiration time is the sum of the timestamp value and the `expiration_offset`. For Enterprise edition databases, the timestamp value may alternatively be stored in an array value in the TTL-enabled field. An expiration time in the past indicates that the document is eligible for immediate expiration. Using any other data type or leaving the field absent will disable expiration for the individual document. # The TTL configuration for this `Field`. Setting or unsetting this will enable or disable the TTL for documents that have this `Field`. + "expirationOffset": "A String", # Optional. The offset, relative to the timestamp value from the TTL-enabled field, used to determine the document's expiration time. `expiration_offset.seconds` must be between 0 and 2,147,483,647 inclusive. Values more precise than seconds are rejected. If unset, defaults to 0, in which case the expiration time is the same as the timestamp value from the TTL-enabled field. "state": "A String", # Output only. The state of the TTL configuration. }, }
@@ -177,6 +201,22 @@

Method Details

"arrayConfig": "A String", # Indicates that this field supports operations on `array_value`s. "fieldPath": "A String", # Can be __name__. For single field indexes, this must match the name of the field or may be omitted. "order": "A String", # Indicates that this field supports ordering by the specified order or comparing using =, !=, <, <=, >, >=. + "searchConfig": { # The configuration for how to index a field for search. # Indicates that this field supports search operations. This field is only currently supported for indexes with MONGODB_COMPATIBLE_API ApiScope. + "geoSpec": { # The specification for how to build a geo search index for a field. # Optional. The specification for building a geo search index for a field. + "geoJsonIndexingDisabled": True or False, # Optional. Disables geoJSON indexing for the field. By default, geoJSON points are indexed. + }, + "numberSpec": { # The specification for how to build a number search index for a field. # Optional. The specification for building a number search index for a field. + "indexType": "A String", # Required. How to index the number field value. + }, + "textSpec": { # The specification for how to build a text search index for a field. # Optional. The specification for building a text search index for a field. + "indexSpecs": [ # Required. Specifications for how the field should be indexed. Repeated so that the field can be indexed in multiple ways. + { # Specification of how the field should be indexed for search text indexes. + "indexType": "A String", # Required. How to index the text field value. + "matchType": "A String", # Required. How to match the text field value. + }, + ], + }, + }, "vectorConfig": { # The index configuration to support vector search operations # Indicates that this field supports nearest neighbor and distance operations on vector. "dimension": 42, # Required. The vector dimension this configuration applies to. The resulting index will only include vectors of this dimension, and can be used for vector search with the same dimension. "flat": { # An index that stores vectors in a flat data structure, and supports exhaustive search. # Indicates the vector index is a flat index. @@ -187,6 +227,13 @@

Method Details

"multikey": True or False, # Optional. Whether the index is multikey. By default, the index is not multikey. For non-multikey indexes, none of the paths in the index definition reach or traverse an array, except via an explicit array index. For multikey indexes, at most one of the paths in the index definition reach or traverse an array, except via an explicit array index. Violations will result in errors. Note this field only applies to index with MONGODB_COMPATIBLE_API ApiScope. "name": "A String", # Output only. A server defined name for this index. The form of this name for composite indexes will be: `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{composite_index_id}` For single field indexes, this field will be empty. "queryScope": "A String", # Indexes with a collection query scope specified allow queries against a collection that is the child of a specific document, specified at query time, and that has the same collection ID. Indexes with a collection group query scope specified allow queries against all collections descended from a specific document, specified at query time, and that have the same collection ID as this index. + "searchIndexOptions": { # Options for search indexes at the definition level. # Optional. Options for search indexes that are at the index definition level. This field is only currently supported for indexes with MONGODB_COMPATIBLE_API ApiScope. + "customPartitionFieldPaths": [ # Optional. Custom partition fields to use for the search index. If unspecified, all indexed fields will be in the same default partition. If a search index is created specifying custom partition fields, all search queries using that index will be required to filter on the partition. For indexes with MONGODB_COMPATIBLE_API ApiScope: This must refer to a top level field name. + "A String", + ], + "textLanguage": "A String", # Optional. The language to use for text search indexes. Used as the default language if not overridden at the document level by specifying the `text_language_override_field`. The language is specified as a BCP 47 language code. For indexes with MONGODB_COMPATIBLE_API ApiScope: If unspecified, the default language is English. For indexes with `ANY_API` ApiScope: If unspecified, the default behavior is autodetect. + "textLanguageOverrideFieldPath": "A String", # Optional. The field in the document that specifies which language to use for that specific document. For indexes with MONGODB_COMPATIBLE_API ApiScope: if unspecified, the language is taken from the "language" field if it exists or from `text_language` if it does not. + }, "shardCount": 42, # Optional. The number of shards for the index. "state": "A String", # Output only. The serving state of the index. "unique": True or False, # Optional. Whether it is an unique index. Unique index ensures all values for the indexed field(s) are unique across documents. @@ -196,7 +243,8 @@

Method Details

"usesAncestorConfig": True or False, # Output only. When true, the `Field`'s index configuration is set from the configuration specified by the `ancestor_field`. When false, the `Field`'s index configuration is defined explicitly. }, "name": "A String", # Required. A field name of the form: `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}` A field path can be a simple field name, e.g. `address` or a path to fields within `map_value` , e.g. `address.city`, or a special field path. The only valid special field is `*`, which represents any field. Field paths can be quoted using `` ` `` (backtick). The only character that must be escaped within a quoted field path is the backtick character itself, escaped using a backslash. Special characters in field paths that must be quoted include: `*`, `.`, `` ` `` (backtick), `[`, `]`, as well as any ascii symbolic characters. Examples: `` `address.city` `` represents a field named `address.city`, not the map key `city` in the field `address`. `` `*` `` represents a field named `*`, not any field. A special `Field` contains the default indexing settings for all fields. This field's resource name is: `projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*` Indexes defined on this `Field` will be applied to all fields which do not have their own `Field` index configuration. - "ttlConfig": { # The TTL (time-to-live) configuration for documents that have this `Field` set. Storing a timestamp value into a TTL-enabled field will be treated as the document's absolute expiration time. For Enterprise edition databases, the timestamp value may also be stored in an array value in the TTL-enabled field. Timestamp values in the past indicate that the document is eligible for immediate expiration. Using any other data type or leaving the field absent will disable expiration for the individual document. # The TTL configuration for this `Field`. Setting or unsetting this will enable or disable the TTL for documents that have this `Field`. + "ttlConfig": { # The TTL (time-to-live) configuration for documents that have this `Field` set. A timestamp stored in a TTL-enabled field will be used to determine the expiration time of the document. The expiration time is the sum of the timestamp value and the `expiration_offset`. For Enterprise edition databases, the timestamp value may alternatively be stored in an array value in the TTL-enabled field. An expiration time in the past indicates that the document is eligible for immediate expiration. Using any other data type or leaving the field absent will disable expiration for the individual document. # The TTL configuration for this `Field`. Setting or unsetting this will enable or disable the TTL for documents that have this `Field`. + "expirationOffset": "A String", # Optional. The offset, relative to the timestamp value from the TTL-enabled field, used to determine the document's expiration time. `expiration_offset.seconds` must be between 0 and 2,147,483,647 inclusive. Values more precise than seconds are rejected. If unset, defaults to 0, in which case the expiration time is the same as the timestamp value from the TTL-enabled field. "state": "A String", # Output only. The state of the TTL configuration. }, }, @@ -240,6 +288,22 @@

Method Details

"arrayConfig": "A String", # Indicates that this field supports operations on `array_value`s. "fieldPath": "A String", # Can be __name__. For single field indexes, this must match the name of the field or may be omitted. "order": "A String", # Indicates that this field supports ordering by the specified order or comparing using =, !=, <, <=, >, >=. + "searchConfig": { # The configuration for how to index a field for search. # Indicates that this field supports search operations. This field is only currently supported for indexes with MONGODB_COMPATIBLE_API ApiScope. + "geoSpec": { # The specification for how to build a geo search index for a field. # Optional. The specification for building a geo search index for a field. + "geoJsonIndexingDisabled": True or False, # Optional. Disables geoJSON indexing for the field. By default, geoJSON points are indexed. + }, + "numberSpec": { # The specification for how to build a number search index for a field. # Optional. The specification for building a number search index for a field. + "indexType": "A String", # Required. How to index the number field value. + }, + "textSpec": { # The specification for how to build a text search index for a field. # Optional. The specification for building a text search index for a field. + "indexSpecs": [ # Required. Specifications for how the field should be indexed. Repeated so that the field can be indexed in multiple ways. + { # Specification of how the field should be indexed for search text indexes. + "indexType": "A String", # Required. How to index the text field value. + "matchType": "A String", # Required. How to match the text field value. + }, + ], + }, + }, "vectorConfig": { # The index configuration to support vector search operations # Indicates that this field supports nearest neighbor and distance operations on vector. "dimension": 42, # Required. The vector dimension this configuration applies to. The resulting index will only include vectors of this dimension, and can be used for vector search with the same dimension. "flat": { # An index that stores vectors in a flat data structure, and supports exhaustive search. # Indicates the vector index is a flat index. @@ -250,6 +314,13 @@

Method Details

"multikey": True or False, # Optional. Whether the index is multikey. By default, the index is not multikey. For non-multikey indexes, none of the paths in the index definition reach or traverse an array, except via an explicit array index. For multikey indexes, at most one of the paths in the index definition reach or traverse an array, except via an explicit array index. Violations will result in errors. Note this field only applies to index with MONGODB_COMPATIBLE_API ApiScope. "name": "A String", # Output only. A server defined name for this index. The form of this name for composite indexes will be: `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{composite_index_id}` For single field indexes, this field will be empty. "queryScope": "A String", # Indexes with a collection query scope specified allow queries against a collection that is the child of a specific document, specified at query time, and that has the same collection ID. Indexes with a collection group query scope specified allow queries against all collections descended from a specific document, specified at query time, and that have the same collection ID as this index. + "searchIndexOptions": { # Options for search indexes at the definition level. # Optional. Options for search indexes that are at the index definition level. This field is only currently supported for indexes with MONGODB_COMPATIBLE_API ApiScope. + "customPartitionFieldPaths": [ # Optional. Custom partition fields to use for the search index. If unspecified, all indexed fields will be in the same default partition. If a search index is created specifying custom partition fields, all search queries using that index will be required to filter on the partition. For indexes with MONGODB_COMPATIBLE_API ApiScope: This must refer to a top level field name. + "A String", + ], + "textLanguage": "A String", # Optional. The language to use for text search indexes. Used as the default language if not overridden at the document level by specifying the `text_language_override_field`. The language is specified as a BCP 47 language code. For indexes with MONGODB_COMPATIBLE_API ApiScope: If unspecified, the default language is English. For indexes with `ANY_API` ApiScope: If unspecified, the default behavior is autodetect. + "textLanguageOverrideFieldPath": "A String", # Optional. The field in the document that specifies which language to use for that specific document. For indexes with MONGODB_COMPATIBLE_API ApiScope: if unspecified, the language is taken from the "language" field if it exists or from `text_language` if it does not. + }, "shardCount": 42, # Optional. The number of shards for the index. "state": "A String", # Output only. The serving state of the index. "unique": True or False, # Optional. Whether it is an unique index. Unique index ensures all values for the indexed field(s) are unique across documents. @@ -259,7 +330,8 @@

Method Details

"usesAncestorConfig": True or False, # Output only. When true, the `Field`'s index configuration is set from the configuration specified by the `ancestor_field`. When false, the `Field`'s index configuration is defined explicitly. }, "name": "A String", # Required. A field name of the form: `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}` A field path can be a simple field name, e.g. `address` or a path to fields within `map_value` , e.g. `address.city`, or a special field path. The only valid special field is `*`, which represents any field. Field paths can be quoted using `` ` `` (backtick). The only character that must be escaped within a quoted field path is the backtick character itself, escaped using a backslash. Special characters in field paths that must be quoted include: `*`, `.`, `` ` `` (backtick), `[`, `]`, as well as any ascii symbolic characters. Examples: `` `address.city` `` represents a field named `address.city`, not the map key `city` in the field `address`. `` `*` `` represents a field named `*`, not any field. A special `Field` contains the default indexing settings for all fields. This field's resource name is: `projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*` Indexes defined on this `Field` will be applied to all fields which do not have their own `Field` index configuration. - "ttlConfig": { # The TTL (time-to-live) configuration for documents that have this `Field` set. Storing a timestamp value into a TTL-enabled field will be treated as the document's absolute expiration time. For Enterprise edition databases, the timestamp value may also be stored in an array value in the TTL-enabled field. Timestamp values in the past indicate that the document is eligible for immediate expiration. Using any other data type or leaving the field absent will disable expiration for the individual document. # The TTL configuration for this `Field`. Setting or unsetting this will enable or disable the TTL for documents that have this `Field`. + "ttlConfig": { # The TTL (time-to-live) configuration for documents that have this `Field` set. A timestamp stored in a TTL-enabled field will be used to determine the expiration time of the document. The expiration time is the sum of the timestamp value and the `expiration_offset`. For Enterprise edition databases, the timestamp value may alternatively be stored in an array value in the TTL-enabled field. An expiration time in the past indicates that the document is eligible for immediate expiration. Using any other data type or leaving the field absent will disable expiration for the individual document. # The TTL configuration for this `Field`. Setting or unsetting this will enable or disable the TTL for documents that have this `Field`. + "expirationOffset": "A String", # Optional. The offset, relative to the timestamp value from the TTL-enabled field, used to determine the document's expiration time. `expiration_offset.seconds` must be between 0 and 2,147,483,647 inclusive. Values more precise than seconds are rejected. If unset, defaults to 0, in which case the expiration time is the same as the timestamp value from the TTL-enabled field. "state": "A String", # Output only. The state of the TTL configuration. }, } diff --git a/docs/dyn/firestore_v1.projects.databases.collectionGroups.indexes.html b/docs/dyn/firestore_v1.projects.databases.collectionGroups.indexes.html index 27287e778b..6d062abe74 100644 --- a/docs/dyn/firestore_v1.projects.databases.collectionGroups.indexes.html +++ b/docs/dyn/firestore_v1.projects.databases.collectionGroups.indexes.html @@ -115,6 +115,22 @@

Method Details

"arrayConfig": "A String", # Indicates that this field supports operations on `array_value`s. "fieldPath": "A String", # Can be __name__. For single field indexes, this must match the name of the field or may be omitted. "order": "A String", # Indicates that this field supports ordering by the specified order or comparing using =, !=, <, <=, >, >=. + "searchConfig": { # The configuration for how to index a field for search. # Indicates that this field supports search operations. This field is only currently supported for indexes with MONGODB_COMPATIBLE_API ApiScope. + "geoSpec": { # The specification for how to build a geo search index for a field. # Optional. The specification for building a geo search index for a field. + "geoJsonIndexingDisabled": True or False, # Optional. Disables geoJSON indexing for the field. By default, geoJSON points are indexed. + }, + "numberSpec": { # The specification for how to build a number search index for a field. # Optional. The specification for building a number search index for a field. + "indexType": "A String", # Required. How to index the number field value. + }, + "textSpec": { # The specification for how to build a text search index for a field. # Optional. The specification for building a text search index for a field. + "indexSpecs": [ # Required. Specifications for how the field should be indexed. Repeated so that the field can be indexed in multiple ways. + { # Specification of how the field should be indexed for search text indexes. + "indexType": "A String", # Required. How to index the text field value. + "matchType": "A String", # Required. How to match the text field value. + }, + ], + }, + }, "vectorConfig": { # The index configuration to support vector search operations # Indicates that this field supports nearest neighbor and distance operations on vector. "dimension": 42, # Required. The vector dimension this configuration applies to. The resulting index will only include vectors of this dimension, and can be used for vector search with the same dimension. "flat": { # An index that stores vectors in a flat data structure, and supports exhaustive search. # Indicates the vector index is a flat index. @@ -125,6 +141,13 @@

Method Details

"multikey": True or False, # Optional. Whether the index is multikey. By default, the index is not multikey. For non-multikey indexes, none of the paths in the index definition reach or traverse an array, except via an explicit array index. For multikey indexes, at most one of the paths in the index definition reach or traverse an array, except via an explicit array index. Violations will result in errors. Note this field only applies to index with MONGODB_COMPATIBLE_API ApiScope. "name": "A String", # Output only. A server defined name for this index. The form of this name for composite indexes will be: `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{composite_index_id}` For single field indexes, this field will be empty. "queryScope": "A String", # Indexes with a collection query scope specified allow queries against a collection that is the child of a specific document, specified at query time, and that has the same collection ID. Indexes with a collection group query scope specified allow queries against all collections descended from a specific document, specified at query time, and that have the same collection ID as this index. + "searchIndexOptions": { # Options for search indexes at the definition level. # Optional. Options for search indexes that are at the index definition level. This field is only currently supported for indexes with MONGODB_COMPATIBLE_API ApiScope. + "customPartitionFieldPaths": [ # Optional. Custom partition fields to use for the search index. If unspecified, all indexed fields will be in the same default partition. If a search index is created specifying custom partition fields, all search queries using that index will be required to filter on the partition. For indexes with MONGODB_COMPATIBLE_API ApiScope: This must refer to a top level field name. + "A String", + ], + "textLanguage": "A String", # Optional. The language to use for text search indexes. Used as the default language if not overridden at the document level by specifying the `text_language_override_field`. The language is specified as a BCP 47 language code. For indexes with MONGODB_COMPATIBLE_API ApiScope: If unspecified, the default language is English. For indexes with `ANY_API` ApiScope: If unspecified, the default behavior is autodetect. + "textLanguageOverrideFieldPath": "A String", # Optional. The field in the document that specifies which language to use for that specific document. For indexes with MONGODB_COMPATIBLE_API ApiScope: if unspecified, the language is taken from the "language" field if it exists or from `text_language` if it does not. + }, "shardCount": 42, # Optional. The number of shards for the index. "state": "A String", # Output only. The serving state of the index. "unique": True or False, # Optional. Whether it is an unique index. Unique index ensures all values for the indexed field(s) are unique across documents. @@ -199,6 +222,22 @@

Method Details

"arrayConfig": "A String", # Indicates that this field supports operations on `array_value`s. "fieldPath": "A String", # Can be __name__. For single field indexes, this must match the name of the field or may be omitted. "order": "A String", # Indicates that this field supports ordering by the specified order or comparing using =, !=, <, <=, >, >=. + "searchConfig": { # The configuration for how to index a field for search. # Indicates that this field supports search operations. This field is only currently supported for indexes with MONGODB_COMPATIBLE_API ApiScope. + "geoSpec": { # The specification for how to build a geo search index for a field. # Optional. The specification for building a geo search index for a field. + "geoJsonIndexingDisabled": True or False, # Optional. Disables geoJSON indexing for the field. By default, geoJSON points are indexed. + }, + "numberSpec": { # The specification for how to build a number search index for a field. # Optional. The specification for building a number search index for a field. + "indexType": "A String", # Required. How to index the number field value. + }, + "textSpec": { # The specification for how to build a text search index for a field. # Optional. The specification for building a text search index for a field. + "indexSpecs": [ # Required. Specifications for how the field should be indexed. Repeated so that the field can be indexed in multiple ways. + { # Specification of how the field should be indexed for search text indexes. + "indexType": "A String", # Required. How to index the text field value. + "matchType": "A String", # Required. How to match the text field value. + }, + ], + }, + }, "vectorConfig": { # The index configuration to support vector search operations # Indicates that this field supports nearest neighbor and distance operations on vector. "dimension": 42, # Required. The vector dimension this configuration applies to. The resulting index will only include vectors of this dimension, and can be used for vector search with the same dimension. "flat": { # An index that stores vectors in a flat data structure, and supports exhaustive search. # Indicates the vector index is a flat index. @@ -209,6 +248,13 @@

Method Details

"multikey": True or False, # Optional. Whether the index is multikey. By default, the index is not multikey. For non-multikey indexes, none of the paths in the index definition reach or traverse an array, except via an explicit array index. For multikey indexes, at most one of the paths in the index definition reach or traverse an array, except via an explicit array index. Violations will result in errors. Note this field only applies to index with MONGODB_COMPATIBLE_API ApiScope. "name": "A String", # Output only. A server defined name for this index. The form of this name for composite indexes will be: `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{composite_index_id}` For single field indexes, this field will be empty. "queryScope": "A String", # Indexes with a collection query scope specified allow queries against a collection that is the child of a specific document, specified at query time, and that has the same collection ID. Indexes with a collection group query scope specified allow queries against all collections descended from a specific document, specified at query time, and that have the same collection ID as this index. + "searchIndexOptions": { # Options for search indexes at the definition level. # Optional. Options for search indexes that are at the index definition level. This field is only currently supported for indexes with MONGODB_COMPATIBLE_API ApiScope. + "customPartitionFieldPaths": [ # Optional. Custom partition fields to use for the search index. If unspecified, all indexed fields will be in the same default partition. If a search index is created specifying custom partition fields, all search queries using that index will be required to filter on the partition. For indexes with MONGODB_COMPATIBLE_API ApiScope: This must refer to a top level field name. + "A String", + ], + "textLanguage": "A String", # Optional. The language to use for text search indexes. Used as the default language if not overridden at the document level by specifying the `text_language_override_field`. The language is specified as a BCP 47 language code. For indexes with MONGODB_COMPATIBLE_API ApiScope: If unspecified, the default language is English. For indexes with `ANY_API` ApiScope: If unspecified, the default behavior is autodetect. + "textLanguageOverrideFieldPath": "A String", # Optional. The field in the document that specifies which language to use for that specific document. For indexes with MONGODB_COMPATIBLE_API ApiScope: if unspecified, the language is taken from the "language" field if it exists or from `text_language` if it does not. + }, "shardCount": 42, # Optional. The number of shards for the index. "state": "A String", # Output only. The serving state of the index. "unique": True or False, # Optional. Whether it is an unique index. Unique index ensures all values for the indexed field(s) are unique across documents. @@ -242,6 +288,22 @@

Method Details

"arrayConfig": "A String", # Indicates that this field supports operations on `array_value`s. "fieldPath": "A String", # Can be __name__. For single field indexes, this must match the name of the field or may be omitted. "order": "A String", # Indicates that this field supports ordering by the specified order or comparing using =, !=, <, <=, >, >=. + "searchConfig": { # The configuration for how to index a field for search. # Indicates that this field supports search operations. This field is only currently supported for indexes with MONGODB_COMPATIBLE_API ApiScope. + "geoSpec": { # The specification for how to build a geo search index for a field. # Optional. The specification for building a geo search index for a field. + "geoJsonIndexingDisabled": True or False, # Optional. Disables geoJSON indexing for the field. By default, geoJSON points are indexed. + }, + "numberSpec": { # The specification for how to build a number search index for a field. # Optional. The specification for building a number search index for a field. + "indexType": "A String", # Required. How to index the number field value. + }, + "textSpec": { # The specification for how to build a text search index for a field. # Optional. The specification for building a text search index for a field. + "indexSpecs": [ # Required. Specifications for how the field should be indexed. Repeated so that the field can be indexed in multiple ways. + { # Specification of how the field should be indexed for search text indexes. + "indexType": "A String", # Required. How to index the text field value. + "matchType": "A String", # Required. How to match the text field value. + }, + ], + }, + }, "vectorConfig": { # The index configuration to support vector search operations # Indicates that this field supports nearest neighbor and distance operations on vector. "dimension": 42, # Required. The vector dimension this configuration applies to. The resulting index will only include vectors of this dimension, and can be used for vector search with the same dimension. "flat": { # An index that stores vectors in a flat data structure, and supports exhaustive search. # Indicates the vector index is a flat index. @@ -252,6 +314,13 @@

Method Details

"multikey": True or False, # Optional. Whether the index is multikey. By default, the index is not multikey. For non-multikey indexes, none of the paths in the index definition reach or traverse an array, except via an explicit array index. For multikey indexes, at most one of the paths in the index definition reach or traverse an array, except via an explicit array index. Violations will result in errors. Note this field only applies to index with MONGODB_COMPATIBLE_API ApiScope. "name": "A String", # Output only. A server defined name for this index. The form of this name for composite indexes will be: `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{composite_index_id}` For single field indexes, this field will be empty. "queryScope": "A String", # Indexes with a collection query scope specified allow queries against a collection that is the child of a specific document, specified at query time, and that has the same collection ID. Indexes with a collection group query scope specified allow queries against all collections descended from a specific document, specified at query time, and that have the same collection ID as this index. + "searchIndexOptions": { # Options for search indexes at the definition level. # Optional. Options for search indexes that are at the index definition level. This field is only currently supported for indexes with MONGODB_COMPATIBLE_API ApiScope. + "customPartitionFieldPaths": [ # Optional. Custom partition fields to use for the search index. If unspecified, all indexed fields will be in the same default partition. If a search index is created specifying custom partition fields, all search queries using that index will be required to filter on the partition. For indexes with MONGODB_COMPATIBLE_API ApiScope: This must refer to a top level field name. + "A String", + ], + "textLanguage": "A String", # Optional. The language to use for text search indexes. Used as the default language if not overridden at the document level by specifying the `text_language_override_field`. The language is specified as a BCP 47 language code. For indexes with MONGODB_COMPATIBLE_API ApiScope: If unspecified, the default language is English. For indexes with `ANY_API` ApiScope: If unspecified, the default behavior is autodetect. + "textLanguageOverrideFieldPath": "A String", # Optional. The field in the document that specifies which language to use for that specific document. For indexes with MONGODB_COMPATIBLE_API ApiScope: if unspecified, the language is taken from the "language" field if it exists or from `text_language` if it does not. + }, "shardCount": 42, # Optional. The number of shards for the index. "state": "A String", # Output only. The serving state of the index. "unique": True or False, # Optional. Whether it is an unique index. Unique index ensures all values for the indexed field(s) are unique across documents. diff --git a/docs/dyn/gkebackup_v1.projects.locations.html b/docs/dyn/gkebackup_v1.projects.locations.html index 84c31ea60c..e550cacd25 100644 --- a/docs/dyn/gkebackup_v1.projects.locations.html +++ b/docs/dyn/gkebackup_v1.projects.locations.html @@ -107,7 +107,7 @@

Instance Methods

Gets information about a location.

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

-

Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.

+

Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.

list_next()

Retrieves the next page of results.

@@ -146,7 +146,7 @@

Method Details

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
+  
Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
diff --git a/docs/dyn/gkeonprem_v1.projects.locations.html b/docs/dyn/gkeonprem_v1.projects.locations.html
index d42320d4a7..1488f23f00 100644
--- a/docs/dyn/gkeonprem_v1.projects.locations.html
+++ b/docs/dyn/gkeonprem_v1.projects.locations.html
@@ -107,7 +107,7 @@ 

Instance Methods

Gets information about a location.

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

-

Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.

+

Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.

list_next()

Retrieves the next page of results.

@@ -146,7 +146,7 @@

Method Details

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
+  
Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
diff --git a/docs/dyn/health_v4.html b/docs/dyn/health_v4.html
new file mode 100644
index 0000000000..e75232bd57
--- /dev/null
+++ b/docs/dyn/health_v4.html
@@ -0,0 +1,111 @@
+
+
+
+

Google Health API

+

Instance Methods

+

+ users() +

+

Returns the users Resource.

+ +

+ close()

+

Close httplib2 connections.

+

+ new_batch_http_request()

+

Create a BatchHttpRequest object based on the discovery document.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ new_batch_http_request() +
Create a BatchHttpRequest object based on the discovery document.
+
+                Args:
+                  callback: callable, A callback to be called for each response, of the
+                    form callback(id, response, exception). The first parameter is the
+                    request id, and the second is the deserialized response object. The
+                    third is an apiclient.errors.HttpError exception object if an HTTP
+                    error occurred while processing the request, or None if no error
+                    occurred.
+
+                Returns:
+                  A BatchHttpRequest object based on the discovery document.
+                
+
+ + \ No newline at end of file diff --git a/docs/dyn/health_v4.users.dataTypes.dataPoints.html b/docs/dyn/health_v4.users.dataTypes.dataPoints.html new file mode 100644 index 0000000000..903840fb38 --- /dev/null +++ b/docs/dyn/health_v4.users.dataTypes.dataPoints.html @@ -0,0 +1,4086 @@ + + + +

Google Health API . users . dataTypes . dataPoints

+

Instance Methods

+

+ batchDelete(parent, body=None, x__xgafv=None)

+

Delete a batch of identifyable data points.

+

+ close()

+

Close httplib2 connections.

+

+ create(parent, body=None, x__xgafv=None)

+

Creates a single identifiable data point.

+

+ dailyRollUp(parent, body=None, x__xgafv=None)

+

Roll up data points over civil time intervals for supported data types.

+

+ exportExerciseTcx(name, partialData=None, x__xgafv=None)

+

Exports exercise data in TCX format. Note: While the Authorization section below states that any one of the listed scopes is accepted, this specific method requires the user to provide both one of the `activity_and_fitness` scopes (`normal` or `readonly`) AND one of the `location` scopes (`normal` or `readonly`) in their access token to succeed.

+

+ exportExerciseTcx_media(name, partialData=None, x__xgafv=None)

+

Exports exercise data in TCX format. Note: While the Authorization section below states that any one of the listed scopes is accepted, this specific method requires the user to provide both one of the `activity_and_fitness` scopes (`normal` or `readonly`) AND one of the `location` scopes (`normal` or `readonly`) in their access token to succeed.

+

+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+

Query user health and fitness data points.

+

+ list_next()

+

Retrieves the next page of results.

+

+ patch(name, body=None, x__xgafv=None)

+

Updates a single identifiable data point. If a data point with the specified `name` is not found, the request will fail.

+

+ reconcile(parent, dataSourceFamily=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+

Reconcile data points from multiple data sources into a single data stream.

+

+ reconcile_next()

+

Retrieves the next page of results.

+

+ rollUp(parent, body=None, x__xgafv=None)

+

Roll up data points over physical time intervals for supported data types.

+

+ rollUp_next()

+

Retrieves the next page of results.

+

Method Details

+
+ batchDelete(parent, body=None, x__xgafv=None) +
Delete a batch of identifyable data points.
+
+Args:
+  parent: string, Optional. Parent (data type) for the Data Point collection Format: `users/me/dataTypes/{data_type}`, e.g.: - `users/me/dataTypes/steps` - `users/me/dataTypes/-` For a list of the supported data types see the DataPoint data union field. Deleting data points across multiple data type collections is supported following https://aip.dev/159. If this is set, the parent of all of the data points specified in `names` must match this field. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request to delete a batch of identifiable data points.
+  "names": [ # Required. The names of the DataPoints to delete. A maximum of 10000 data points can be deleted in a single request.
+    "A String",
+  ],
+}
+
+  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, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, x__xgafv=None) +
Creates a single identifiable data point.
+
+Args:
+  parent: string, Required. The parent resource name where the data point will be created. Format: `users/{user}/dataTypes/{data_type}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A computed or recorded metric.
+  "activeMinutes": { # Record of active minutes in a given time interval. # Optional. Data for points in the `active-minutes` interval data type collection.
+    "activeMinutesByActivityLevel": [ # Required. Active minutes by activity level. At most one record per activity level is allowed.
+      { # Active minutes at a given activity level.
+        "activeMinutes": "A String", # Required. Number of whole minutes spent in activity.
+        "activityLevel": "A String", # Required. The level of activity.
+      },
+    ],
+    "interval": { # Represents a time interval of an observed data point. # Required. Observed interval.
+      "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval end time in civil time in the timezone the subject is in at the end of the observed interval
+        "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+          "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+          "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+          "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+        },
+        "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+          "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+          "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+          "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+          "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+        },
+      },
+      "civilStartTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval start time in civil time in the timezone the subject is in at the start of the observed interval
+        "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+          "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+          "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+          "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+        },
+        "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+          "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+          "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+          "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+          "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+        },
+      },
+      "endTime": "A String", # Required. Observed interval end time.
+      "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the observation relative to the Coordinated Universal Time (UTC).
+      "startTime": "A String", # Required. Observed interval start time.
+      "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the observation relative to the Coordinated Universal Time (UTC).
+    },
+  },
+  "activeZoneMinutes": { # Record of active zone minutes in a given time interval. # Optional. Data for points in the `active-zone-minutes` interval data type collection, measured in minutes.
+    "activeZoneMinutes": "A String", # Required. Number of Active Zone Minutes earned in the given time interval. Note: active_zone_minutes equals to 1 for low intensity (fat burn) zones or 2 for high intensity zones (cardio, peak).
+    "heartRateZone": "A String", # Required. Heart rate zone in which the active zone minutes have been earned, in the given time interval.
+    "interval": { # Represents a time interval of an observed data point. # Required. Observed interval.
+      "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval end time in civil time in the timezone the subject is in at the end of the observed interval
+        "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+          "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+          "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+          "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+        },
+        "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+          "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+          "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+          "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+          "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+        },
+      },
+      "civilStartTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval start time in civil time in the timezone the subject is in at the start of the observed interval
+        "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+          "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+          "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+          "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+        },
+        "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+          "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+          "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+          "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+          "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+        },
+      },
+      "endTime": "A String", # Required. Observed interval end time.
+      "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the observation relative to the Coordinated Universal Time (UTC).
+      "startTime": "A String", # Required. Observed interval start time.
+      "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the observation relative to the Coordinated Universal Time (UTC).
+    },
+  },
+  "activityLevel": { # Internal type to capture activity level during a certain time interval. # Optional. Data for points in the `activity-level` daily data type collection.
+    "activityLevelType": "A String", # Required. Activity level type in the given time interval.
+    "interval": { # Represents a time interval of an observed data point. # Required. Observed interval.
+      "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval end time in civil time in the timezone the subject is in at the end of the observed interval
+        "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+          "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+          "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+          "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+        },
+        "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+          "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+          "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+          "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+          "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+        },
+      },
+      "civilStartTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval start time in civil time in the timezone the subject is in at the start of the observed interval
+        "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+          "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+          "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+          "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+        },
+        "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+          "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+          "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+          "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+          "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+        },
+      },
+      "endTime": "A String", # Required. Observed interval end time.
+      "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the observation relative to the Coordinated Universal Time (UTC).
+      "startTime": "A String", # Required. Observed interval start time.
+      "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the observation relative to the Coordinated Universal Time (UTC).
+    },
+  },
+  "altitude": { # Captures the altitude gain (i.e. deltas), and not level above sea, for a user in millimeters. # Optional. Data for points in the `altitude` interval data type collection.
+    "gainMillimeters": "A String", # Required. Altitude gain in millimeters over the observed interval.
+    "interval": { # Represents a time interval of an observed data point. # Required. Observed interval.
+      "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval end time in civil time in the timezone the subject is in at the end of the observed interval
+        "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+          "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+          "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+          "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+        },
+        "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+          "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+          "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+          "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+          "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+        },
+      },
+      "civilStartTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval start time in civil time in the timezone the subject is in at the start of the observed interval
+        "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+          "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+          "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+          "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+        },
+        "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+          "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+          "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+          "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+          "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+        },
+      },
+      "endTime": "A String", # Required. Observed interval end time.
+      "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the observation relative to the Coordinated Universal Time (UTC).
+      "startTime": "A String", # Required. Observed interval start time.
+      "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the observation relative to the Coordinated Universal Time (UTC).
+    },
+  },
+  "bodyFat": { # Body fat measurement. # Optional. Data for points in the `body-fat` sample data type collection.
+    "percentage": 3.14, # Required. Body fat percentage, in range [0, 100].
+    "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which body fat was measured.
+      "civilTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. The civil time in the timezone the subject is in at the time of the observation.
+        "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+          "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+          "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+          "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+        },
+        "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+          "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+          "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+          "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+          "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+        },
+      },
+      "physicalTime": "A String", # Required. The time of the observation.
+      "utcOffset": "A String", # Required. The offset of the user's local time during the observation relative to the Coordinated Universal Time (UTC).
+    },
+  },
+  "dailyHeartRateVariability": { # Represents the daily heart rate variability data type. At least one of the following fields must be set: - `average_heart_rate_variability_milliseconds` - `non_rem_heart_rate_beats_per_minute` - `entropy` - `deep_sleep_root_mean_square_of_successive_differences_milliseconds` # Optional. Data for points in the `daily-heart-rate-variability` daily data type collection.
+    "averageHeartRateVariabilityMilliseconds": 3.14, # Optional. A user's average heart rate variability calculated using the root mean square of successive differences (RMSSD) in times between heartbeats.
+    "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Date (in the user's timezone) of heart rate variability measurement.
+      "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+      "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+      "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+    },
+    "deepSleepRootMeanSquareOfSuccessiveDifferencesMilliseconds": 3.14, # Optional. The root mean square of successive differences (RMSSD) value during deep sleep.
+    "entropy": 3.14, # Optional. The Shanon entropy of heartbeat intervals. Entropy quantifies randomness or disorder in a system. High entropy indicates high HRV. Entropy is measured from the histogram of time interval between successive heart beats values measured during sleep.
+    "nonRemHeartRateBeatsPerMinute": "A String", # Optional. Non-REM heart rate
+  },
+  "dailyHeartRateZones": { # User's heart rate zone thresholds based on the Karvonen algorithm for a specific day. # Optional. Data for points in the `daily-heart-rate-zones` daily data type collection.
+    "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Date (in user's timezone) of the heart rate zones record.
+      "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+      "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+      "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+    },
+    "heartRateZones": [ # Required. The heart rate zones.
+      { # The heart rate zone.
+        "heartRateZoneType": "A String", # Required. The heart rate zone type.
+        "maxBeatsPerMinute": "A String", # Required. Maximum heart rate for this zone in beats per minute.
+        "minBeatsPerMinute": "A String", # Required. Minimum heart rate for this zone in beats per minute.
+      },
+    ],
+  },
+  "dailyOxygenSaturation": { # A daily oxygen saturation (SpO2) record. Represents the user's daily oxygen saturation summary, typically calculated during sleep. # Optional. Data for points in the `daily-oxygen-saturation` daily data type collection.
+    "averagePercentage": 3.14, # Required. The average value of the oxygen saturation samples during the sleep.
+    "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Date (in user's timezone) of the daily oxygen saturation record.
+      "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+      "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+      "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+    },
+    "lowerBoundPercentage": 3.14, # Required. The lower bound of the confidence interval of oxygen saturation samples during sleep.
+    "standardDeviationPercentage": 3.14, # Optional. Standard deviation of the daily oxygen saturation averages from the past 7-30 days.
+    "upperBoundPercentage": 3.14, # Required. The upper bound of the confidence interval of oxygen saturation samples during sleep.
+  },
+  "dailyRespiratoryRate": { # A daily average respiratory rate (breaths per minute) for a day of the year. One data point per day calculated for the main sleep. # Optional. Data for points in the `daily-respiratory-rate` daily data type collection.
+    "breathsPerMinute": 3.14, # Required. The average number of breaths taken per minute.
+    "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. The date on which the respiratory rate was measured.
+      "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+      "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+      "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+    },
+  },
+  "dailyRestingHeartRate": { # Measures the daily resting heart rate for a user, calculated using the all day heart rate measurements. # Optional. Data for points in the `daily-resting-heart-rate` daily data type collection.
+    "beatsPerMinute": "A String", # Required. The resting heart rate value in beats per minute.
+    "dailyRestingHeartRateMetadata": { # Metadata for the daily resting heart rate. # Optional. Metadata for the daily resting heart rate.
+      "calculationMethod": "A String", # Required. The method used to calculate the resting heart rate.
+    },
+    "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Date (in the user's timezone) of the resting heart rate measurement.
+      "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+      "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+      "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+    },
+  },
+  "dailySleepTemperatureDerivations": { # Provides derived sleep temperature values, calculated from skin or internal device temperature readings during sleep. # Optional. Data for points in the `daily-sleep-temperature-derivations` daily data type collection.
+    "baselineTemperatureCelsius": 3.14, # Optional. The user's baseline skin temperature. It is the median of the user's nightly skin temperature over the past 30 days.
+    "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Date for which the sleep temperature derivations are calculated.
+      "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+      "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+      "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+    },
+    "nightlyTemperatureCelsius": 3.14, # Required. The user's nightly skin temperature. It is the mean of skin temperature samples taken from the user’s sleep.
+    "relativeNightlyStddev30dCelsius": 3.14, # Optional. The standard deviation of the user’s relative nightly skin temperature (temperature - baseline) over the past 30 days.
+  },
+  "dailyVo2Max": { # Contains a daily summary of the user's VO2 max (cardio fitness score), which is the maximum rate of oxygen the body can use during exercise. # Optional. Data for points in the `daily-vo2-max` daily data type collection.
+    "cardioFitnessLevel": "A String", # Optional. Represents the user's cardio fitness level based on their VO2 max.
+    "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. The date for which the Daily VO2 max was measured.
+      "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+      "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+      "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+    },
+    "estimated": True or False, # Optional. An estimated field is added to indicate when the confidence has decreased sufficiently to consider the value an estimation.
+    "vo2Max": 3.14, # Required. Daily VO2 max value measured as in ml consumed oxygen / kg of body weight / min.
+    "vo2MaxCovariance": 3.14, # Optional. The covariance of the VO2 max value.
+  },
+  "dataSource": { # Data Source definition to track the origin of data. Each health data point, regardless of the complexity or data model (whether a simple step count or a detailed sleep session) must retain information about its source of origin (e.g. the device or app that collected it). # Optional. Data source information for the metric
+    "application": { # Optional metadata for the application that provided this data. # Output only. Captures metadata for the application that provided this data.
+      "googleWebClientId": "A String", # Output only. The Google OAuth 2.0 client ID of the web application or service that recorded the data. This is the client ID used during the Google OAuth flow to obtain user credentials. This field is system-populated when the data is uploaded from Google Web API.
+      "packageName": "A String", # Output only. A unique identifier for the mobile application that was the source of the data. This is typically the application's package name on Android (e.g., `com.google.fitbit`) or the bundle ID on iOS. This field is informational and helps trace data origin. This field is system-populated when the data is uploaded from the Fitbit mobile application, Health Connect or Health Kit.
+      "webClientId": "A String", # Output only. The client ID of the application that recorded the data. This ID is a legacy Fitbit API client ID, which is different from a Google OAuth client ID. Example format: `ABC123`. This field is system-populated and used for tracing data from legacy Fitbit API integrations. This field is system-populated when the data is uploaded from a legacy Fitbit API integration.
+    },
+    "device": { # Captures metadata about the device that recorded the measurement. # Optional. Captures metadata for raw data points originating from devices. We expect this data source to be used for data points written on device sync.
+      "displayName": "A String", # Optional. An optional name for the device.
+      "formFactor": "A String", # Optional. Captures the form factor of the device.
+      "manufacturer": "A String", # Optional. An optional manufacturer of the device.
+    },
+    "platform": "A String", # Output only. Captures the platform that uploaded the data.
+    "recordingMethod": "A String", # Optional. Captures how the data was recorded.
+  },
+  "distance": { # Distance traveled over an interval of time. # Optional. Data for points in the `distance` interval data type collection.
+    "interval": { # Represents a time interval of an observed data point. # Required. Observed interval.
+      "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval end time in civil time in the timezone the subject is in at the end of the observed interval
+        "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+          "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+          "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+          "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+        },
+        "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+          "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+          "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+          "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+          "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+        },
+      },
+      "civilStartTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval start time in civil time in the timezone the subject is in at the start of the observed interval
+        "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+          "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+          "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+          "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+        },
+        "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+          "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+          "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+          "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+          "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+        },
+      },
+      "endTime": "A String", # Required. Observed interval end time.
+      "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the observation relative to the Coordinated Universal Time (UTC).
+      "startTime": "A String", # Required. Observed interval start time.
+      "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the observation relative to the Coordinated Universal Time (UTC).
+    },
+    "millimeters": "A String", # Required. Distance in millimeters over the observed interval.
+  },
+  "exercise": { # An exercise that stores information about a physical activity. # Optional. Data for points in the `exercise` session data type collection.
+    "activeDuration": "A String", # Optional. Duration excluding pauses.
+    "createTime": "A String", # Output only. Represents the timestamp of the creation of the exercise.
+    "displayName": "A String", # Required. Exercise display name.
+    "exerciseEvents": [ # Optional. Exercise events that happen during an exercise, such as pause & restarts.
+      { # Represents instantaneous events that happen during an exercise, such as start, stop, pause, split.
+        "eventTime": "A String", # Required. Exercise event time
+        "eventUtcOffset": "A String", # Required. Exercise event time offset from UTC
+        "exerciseEventType": "A String", # Required. The type of the event, such as start, stop, pause, resume.
+      },
+    ],
+    "exerciseMetadata": { # Additional exercise metadata. # Optional. Additional exercise metadata.
+      "hasGps": True or False, # Optional. Whether the exercise had GPS tracking.
+      "poolLengthMillimeters": "A String", # Optional. Pool length in millimeters. Only present in the swimming exercises.
+    },
+    "exerciseType": "A String", # Required. The type of activity performed during an exercise.
+    "interval": { # Represents a time interval of session data point, which bundles multiple observed metrics together. # Required. Observed exercise interval
+      "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Session end time in civil time in the timezone the subject is in at the end of the session.
+        "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+          "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+          "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+          "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+        },
+        "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+          "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+          "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+          "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+          "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+        },
+      },
+      "civilStartTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Session start time in civil time in the timezone the subject is in at the start of the session.
+        "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+          "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+          "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+          "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+        },
+        "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+          "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+          "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+          "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+          "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+        },
+      },
+      "endTime": "A String", # Required. The end time of the observed session.
+      "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the session relative to the Coordinated Universal Time (UTC).
+      "startTime": "A String", # Required. The start time of the observed session.
+      "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the session relative to the Coordinated Universal Time (UTC).
+    },
+    "metricsSummary": { # Summary metrics for an exercise. # Required. Summary metrics for this exercise ( )
+      "activeZoneMinutes": "A String", # Optional. Total active zone minutes for the exercise.
+      "averageHeartRateBeatsPerMinute": "A String", # Optional. Average heart rate during the exercise.
+      "averagePaceSecondsPerMeter": 3.14, # Optional. Average pace in seconds per meter.
+      "averageSpeedMillimetersPerSecond": 3.14, # Optional. Average speed in millimeters per second.
+      "caloriesKcal": 3.14, # Optional. Total calories burned by the user during the exercise.
+      "distanceMillimeters": 3.14, # Optional. Total distance covered by the user during the exercise.
+      "elevationGainMillimeters": 3.14, # Optional. Total elevation gain during the exercise.
+      "heartRateZoneDurations": { # Time spent in each heart rate zone. # Optional. Time spent in each heart rate zone.
+        "lightTime": "A String", # Optional. Time spent in light heart rate zone.
+        "moderateTime": "A String", # Optional. Time spent in moderate heart rate zone.
+        "peakTime": "A String", # Optional. Time spent in peak heart rate zone.
+        "vigorousTime": "A String", # Optional. Time spent in vigorous heart rate zone.
+      },
+      "mobilityMetrics": { # Mobility workouts specific metrics # Optional. Mobility workouts specific metrics. Only present in the advanced running exercises.
+        "avgCadenceStepsPerMinute": 3.14, # Optional. Cadence is a measure of the frequency of your foot strikes. Steps / min in real time during workout.
+        "avgGroundContactTimeDuration": "A String", # Optional. The ground contact time for a particular stride is the amount of time for which the foot was in contact with the ground on that stride
+        "avgStrideLengthMillimeters": "A String", # Optional. Stride length is a measure of the distance covered by a single stride
+        "avgVerticalOscillationMillimeters": "A String", # Optional. Distance off the ground your center of mass moves with each stride while running
+        "avgVerticalRatio": 3.14, # Optional. Vertical oscillation/stride length between [5.0, 11.0].
+      },
+      "runVo2Max": 3.14, # Optional. Run VO2 max value for the exercise. Only present in the running exercises at the top level as in the summary of the whole exercise.
+      "steps": "A String", # Optional. Total steps taken during the exercise.
+      "totalSwimLengths": 3.14, # Optional. Number of full pool lengths completed during the exercise. Only present in the swimming exercises at the top level as in the summary of the whole exercise.
+    },
+    "notes": "A String", # Optional. Standard free-form notes captured at manual logging.
+    "splitSummaries": [ # Optional. Laps or splits recorded within an exercise. Laps could be split based on distance or other criteria (duration, etc.) Laps should not be overlapping with each other.
+      { # Represents splits or laps recorded within an exercise. Lap events partition a workout into segments based on criteria like distance, time, or calories.
+        "activeDuration": "A String", # Output only. Lap time excluding the pauses.
+        "endTime": "A String", # Required. Lap end time
+        "endUtcOffset": "A String", # Required. Lap end time offset from UTC
+        "metricsSummary": { # Summary metrics for an exercise. # Required. Summary metrics for this split.
+          "activeZoneMinutes": "A String", # Optional. Total active zone minutes for the exercise.
+          "averageHeartRateBeatsPerMinute": "A String", # Optional. Average heart rate during the exercise.
+          "averagePaceSecondsPerMeter": 3.14, # Optional. Average pace in seconds per meter.
+          "averageSpeedMillimetersPerSecond": 3.14, # Optional. Average speed in millimeters per second.
+          "caloriesKcal": 3.14, # Optional. Total calories burned by the user during the exercise.
+          "distanceMillimeters": 3.14, # Optional. Total distance covered by the user during the exercise.
+          "elevationGainMillimeters": 3.14, # Optional. Total elevation gain during the exercise.
+          "heartRateZoneDurations": { # Time spent in each heart rate zone. # Optional. Time spent in each heart rate zone.
+            "lightTime": "A String", # Optional. Time spent in light heart rate zone.
+            "moderateTime": "A String", # Optional. Time spent in moderate heart rate zone.
+            "peakTime": "A String", # Optional. Time spent in peak heart rate zone.
+            "vigorousTime": "A String", # Optional. Time spent in vigorous heart rate zone.
+          },
+          "mobilityMetrics": { # Mobility workouts specific metrics # Optional. Mobility workouts specific metrics. Only present in the advanced running exercises.
+            "avgCadenceStepsPerMinute": 3.14, # Optional. Cadence is a measure of the frequency of your foot strikes. Steps / min in real time during workout.
+            "avgGroundContactTimeDuration": "A String", # Optional. The ground contact time for a particular stride is the amount of time for which the foot was in contact with the ground on that stride
+            "avgStrideLengthMillimeters": "A String", # Optional. Stride length is a measure of the distance covered by a single stride
+            "avgVerticalOscillationMillimeters": "A String", # Optional. Distance off the ground your center of mass moves with each stride while running
+            "avgVerticalRatio": 3.14, # Optional. Vertical oscillation/stride length between [5.0, 11.0].
+          },
+          "runVo2Max": 3.14, # Optional. Run VO2 max value for the exercise. Only present in the running exercises at the top level as in the summary of the whole exercise.
+          "steps": "A String", # Optional. Total steps taken during the exercise.
+          "totalSwimLengths": 3.14, # Optional. Number of full pool lengths completed during the exercise. Only present in the swimming exercises at the top level as in the summary of the whole exercise.
+        },
+        "splitType": "A String", # Required. Method used to split the exercise laps. Users may manually mark the lap as complete even if the tracking is automatic.
+        "startTime": "A String", # Required. Lap start time
+        "startUtcOffset": "A String", # Required. Lap start time offset from UTC
+      },
+    ],
+    "splits": [ # Optional. The default split is 1 km or 1 mile. - if the movement distance is less than the default, then there are no splits - if the movement distance is greater than or equal to the default, then we have splits
+      { # Represents splits or laps recorded within an exercise. Lap events partition a workout into segments based on criteria like distance, time, or calories.
+        "activeDuration": "A String", # Output only. Lap time excluding the pauses.
+        "endTime": "A String", # Required. Lap end time
+        "endUtcOffset": "A String", # Required. Lap end time offset from UTC
+        "metricsSummary": { # Summary metrics for an exercise. # Required. Summary metrics for this split.
+          "activeZoneMinutes": "A String", # Optional. Total active zone minutes for the exercise.
+          "averageHeartRateBeatsPerMinute": "A String", # Optional. Average heart rate during the exercise.
+          "averagePaceSecondsPerMeter": 3.14, # Optional. Average pace in seconds per meter.
+          "averageSpeedMillimetersPerSecond": 3.14, # Optional. Average speed in millimeters per second.
+          "caloriesKcal": 3.14, # Optional. Total calories burned by the user during the exercise.
+          "distanceMillimeters": 3.14, # Optional. Total distance covered by the user during the exercise.
+          "elevationGainMillimeters": 3.14, # Optional. Total elevation gain during the exercise.
+          "heartRateZoneDurations": { # Time spent in each heart rate zone. # Optional. Time spent in each heart rate zone.
+            "lightTime": "A String", # Optional. Time spent in light heart rate zone.
+            "moderateTime": "A String", # Optional. Time spent in moderate heart rate zone.
+            "peakTime": "A String", # Optional. Time spent in peak heart rate zone.
+            "vigorousTime": "A String", # Optional. Time spent in vigorous heart rate zone.
+          },
+          "mobilityMetrics": { # Mobility workouts specific metrics # Optional. Mobility workouts specific metrics. Only present in the advanced running exercises.
+            "avgCadenceStepsPerMinute": 3.14, # Optional. Cadence is a measure of the frequency of your foot strikes. Steps / min in real time during workout.
+            "avgGroundContactTimeDuration": "A String", # Optional. The ground contact time for a particular stride is the amount of time for which the foot was in contact with the ground on that stride
+            "avgStrideLengthMillimeters": "A String", # Optional. Stride length is a measure of the distance covered by a single stride
+            "avgVerticalOscillationMillimeters": "A String", # Optional. Distance off the ground your center of mass moves with each stride while running
+            "avgVerticalRatio": 3.14, # Optional. Vertical oscillation/stride length between [5.0, 11.0].
+          },
+          "runVo2Max": 3.14, # Optional. Run VO2 max value for the exercise. Only present in the running exercises at the top level as in the summary of the whole exercise.
+          "steps": "A String", # Optional. Total steps taken during the exercise.
+          "totalSwimLengths": 3.14, # Optional. Number of full pool lengths completed during the exercise. Only present in the swimming exercises at the top level as in the summary of the whole exercise.
+        },
+        "splitType": "A String", # Required. Method used to split the exercise laps. Users may manually mark the lap as complete even if the tracking is automatic.
+        "startTime": "A String", # Required. Lap start time
+        "startUtcOffset": "A String", # Required. Lap start time offset from UTC
+      },
+    ],
+    "updateTime": "A String", # Output only. This is the timestamp of the last update to the exercise.
+  },
+  "floors": { # Gained elevation measured in floors over the time interval # Optional. Data for points in the `floors` interval data type collection.
+    "count": "A String", # Required. Number of floors in the recorded interval
+    "interval": { # Represents a time interval of an observed data point. # Required. Observed interval
+      "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval end time in civil time in the timezone the subject is in at the end of the observed interval
+        "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+          "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+          "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+          "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+        },
+        "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+          "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+          "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+          "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+          "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+        },
+      },
+      "civilStartTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval start time in civil time in the timezone the subject is in at the start of the observed interval
+        "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+          "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+          "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+          "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+        },
+        "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+          "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+          "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+          "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+          "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+        },
+      },
+      "endTime": "A String", # Required. Observed interval end time.
+      "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the observation relative to the Coordinated Universal Time (UTC).
+      "startTime": "A String", # Required. Observed interval start time.
+      "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the observation relative to the Coordinated Universal Time (UTC).
+    },
+  },
+  "heartRate": { # A heart rate measurement. # Optional. Data for points in the `heart-rate` sample data type collection.
+    "beatsPerMinute": "A String", # Required. The heart rate value in beats per minute.
+    "metadata": { # Heart rate metadata. # Optional. Metadata about the heart rate sample.
+      "motionContext": "A String", # Optional. Indicates the user’s level of activity when the heart rate sample was measured
+      "sensorLocation": "A String", # Optional. Indicates the location of the sensor that measured the heart rate.
+    },
+    "sampleTime": { # Represents a sample time of an observed data point. # Required. Observation time
+      "civilTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. The civil time in the timezone the subject is in at the time of the observation.
+        "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+          "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+          "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+          "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+        },
+        "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+          "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+          "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+          "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+          "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+        },
+      },
+      "physicalTime": "A String", # Required. The time of the observation.
+      "utcOffset": "A String", # Required. The offset of the user's local time during the observation relative to the Coordinated Universal Time (UTC).
+    },
+  },
+  "heartRateVariability": { # Captures user's heart rate variability (HRV) as measured by the root mean square of successive differences (RMSSD) between normal heartbeats or by standard deviation of the inter-beat intervals (SDNN). # Optional. Data for points in the `heart-rate-variability` sample data type collection.
+    "rootMeanSquareOfSuccessiveDifferencesMilliseconds": 3.14, # Optional. The root mean square of successive differences between normal heartbeats. This is a measure of heart rate variability used by Fitbit.
+    "sampleTime": { # Represents a sample time of an observed data point. # Required. The time of the heart rate variability measurement.
+      "civilTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. The civil time in the timezone the subject is in at the time of the observation.
+        "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+          "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+          "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+          "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+        },
+        "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+          "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+          "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+          "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+          "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+        },
+      },
+      "physicalTime": "A String", # Required. The time of the observation.
+      "utcOffset": "A String", # Required. The offset of the user's local time during the observation relative to the Coordinated Universal Time (UTC).
+    },
+    "standardDeviationMilliseconds": 3.14, # Optional. The standard deviation of the heart rate variability measurement.
+  },
+  "hydrationLog": { # Holds information about a user logged hydration. # Optional. Data for points in the `hydration-log` session data type collection.
+    "amountConsumed": { # Represents the volume quantity. # Required. Amount of liquid (ex. water) consumed.
+      "milliliters": 3.14, # Required. Value representing the volume in milliliters.
+      "userProvidedUnit": "A String", # Optional. Value representing the user provided unit.
+    },
+    "interval": { # Represents a time interval of session data point, which bundles multiple observed metrics together. # Required. Observed interval.
+      "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Session end time in civil time in the timezone the subject is in at the end of the session.
+        "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+          "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+          "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+          "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+        },
+        "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+          "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+          "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+          "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+          "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+        },
+      },
+      "civilStartTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Session start time in civil time in the timezone the subject is in at the start of the session.
+        "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+          "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+          "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+          "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+        },
+        "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+          "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+          "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+          "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+          "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+        },
+      },
+      "endTime": "A String", # Required. The end time of the observed session.
+      "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the session relative to the Coordinated Universal Time (UTC).
+      "startTime": "A String", # Required. The start time of the observed session.
+      "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the session relative to the Coordinated Universal Time (UTC).
+    },
+  },
+  "name": "A String", # Identifier. Data point name, only supported for the subset of identifiable data types. For the majority of the data types, individual data points do not need to be identified and this field would be empty. Format: `users/{user}/dataTypes/{data_type}/dataPoints/{data_point}` Example: `users/abcd1234/dataTypes/sleep/dataPoints/a1b2c3d4-e5f6-7890-1234-567890abcdef` The `{user}` ID is a system-generated identifier, as described in Identity.health_user_id. The `{data_type}` ID corresponds to the kebab-case version of the field names in the DataPoint data union field, e.g. `total-calories` for the `total_calories` field. The `{data_point}` ID can be client-provided or system-generated. If client-provided, it must be a string of 4-63 characters, containing only lowercase letters, numbers, and hyphens.
+  "oxygenSaturation": { # Captures the user's instantaneous oxygen saturation percentage (SpO2). # Optional. Data for points in the `oxygen-saturation` sample data type collection.
+    "percentage": 3.14, # Required. The oxygen saturation percentage. Valid values are from 0 to 100.
+    "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which oxygen saturation was measured.
+      "civilTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. The civil time in the timezone the subject is in at the time of the observation.
+        "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+          "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+          "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+          "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+        },
+        "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+          "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+          "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+          "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+          "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+        },
+      },
+      "physicalTime": "A String", # Required. The time of the observation.
+      "utcOffset": "A String", # Required. The offset of the user's local time during the observation relative to the Coordinated Universal Time (UTC).
+    },
+  },
+  "respiratoryRateSleepSummary": { # Records respiratory rate details during sleep. Can have multiple per day if the user sleeps multiple times. # Optional. Data for points in the `respiratory-rate-sleep-summary` sample data type collection.
+    "deepSleepStats": { # Respiratory rate statistics for a given sleep stage. # Optional. Respiratory rate statistics for deep sleep.
+      "breathsPerMinute": 3.14, # Required. Average breaths per minute.
+      "signalToNoise": 3.14, # Optional. How trustworthy the data is for the computation.
+      "standardDeviation": 3.14, # Optional. Standard deviation of the respiratory rate during sleep.
+    },
+    "fullSleepStats": { # Respiratory rate statistics for a given sleep stage. # Required. Full respiratory rate statistics.
+      "breathsPerMinute": 3.14, # Required. Average breaths per minute.
+      "signalToNoise": 3.14, # Optional. How trustworthy the data is for the computation.
+      "standardDeviation": 3.14, # Optional. Standard deviation of the respiratory rate during sleep.
+    },
+    "lightSleepStats": { # Respiratory rate statistics for a given sleep stage. # Optional. Respiratory rate statistics for light sleep.
+      "breathsPerMinute": 3.14, # Required. Average breaths per minute.
+      "signalToNoise": 3.14, # Optional. How trustworthy the data is for the computation.
+      "standardDeviation": 3.14, # Optional. Standard deviation of the respiratory rate during sleep.
+    },
+    "remSleepStats": { # Respiratory rate statistics for a given sleep stage. # Optional. Respiratory rate statistics for REM sleep.
+      "breathsPerMinute": 3.14, # Required. Average breaths per minute.
+      "signalToNoise": 3.14, # Optional. How trustworthy the data is for the computation.
+      "standardDeviation": 3.14, # Optional. Standard deviation of the respiratory rate during sleep.
+    },
+    "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which respiratory rate was measured.
+      "civilTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. The civil time in the timezone the subject is in at the time of the observation.
+        "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+          "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+          "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+          "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+        },
+        "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+          "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+          "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+          "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+          "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+        },
+      },
+      "physicalTime": "A String", # Required. The time of the observation.
+      "utcOffset": "A String", # Required. The offset of the user's local time during the observation relative to the Coordinated Universal Time (UTC).
+    },
+  },
+  "runVo2Max": { # VO2 max value calculated based on the user's running activity. Value stored in ml/kg/min. # Optional. Data for points in the `run-vo2-max` sample data type collection.
+    "runVo2Max": 3.14, # Required. Run VO2 max value in ml/kg/min.
+    "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which the metric was measured.
+      "civilTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. The civil time in the timezone the subject is in at the time of the observation.
+        "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+          "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+          "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+          "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+        },
+        "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+          "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+          "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+          "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+          "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+        },
+      },
+      "physicalTime": "A String", # Required. The time of the observation.
+      "utcOffset": "A String", # Required. The offset of the user's local time during the observation relative to the Coordinated Universal Time (UTC).
+    },
+  },
+  "sedentaryPeriod": { # SedentaryPeriod SedentaryPeriod data represents the periods of time that the user was sedentary (i.e. not moving while wearing the device). # Optional. Data for points in the `sedentary-period` interval data type collection.
+    "interval": { # Represents a time interval of an observed data point. # Required. Observed interval.
+      "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval end time in civil time in the timezone the subject is in at the end of the observed interval
+        "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+          "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+          "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+          "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+        },
+        "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+          "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+          "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+          "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+          "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+        },
+      },
+      "civilStartTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval start time in civil time in the timezone the subject is in at the start of the observed interval
+        "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+          "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+          "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+          "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+        },
+        "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+          "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+          "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+          "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+          "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+        },
+      },
+      "endTime": "A String", # Required. Observed interval end time.
+      "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the observation relative to the Coordinated Universal Time (UTC).
+      "startTime": "A String", # Required. Observed interval start time.
+      "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the observation relative to the Coordinated Universal Time (UTC).
+    },
+  },
+  "sleep": { # A sleep session possibly including stages. # Optional. Data for points in the `sleep` session data type collection.
+    "createTime": "A String", # Output only. Creation time of this sleep observation.
+    "interval": { # Represents a time interval of session data point, which bundles multiple observed metrics together. # Required. Observed sleep interval.
+      "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Session end time in civil time in the timezone the subject is in at the end of the session.
+        "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+          "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+          "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+          "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+        },
+        "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+          "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+          "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+          "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+          "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+        },
+      },
+      "civilStartTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Session start time in civil time in the timezone the subject is in at the start of the session.
+        "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+          "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+          "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+          "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+        },
+        "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+          "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+          "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+          "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+          "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+        },
+      },
+      "endTime": "A String", # Required. The end time of the observed session.
+      "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the session relative to the Coordinated Universal Time (UTC).
+      "startTime": "A String", # Required. The start time of the observed session.
+      "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the session relative to the Coordinated Universal Time (UTC).
+    },
+    "metadata": { # Additional information about how the sleep was processed. # Optional. Sleep metadata: processing, main, manually edited, stages status.
+      "externalId": "A String", # Optional. Sleep identifier relevant in the context of the data source.
+      "manuallyEdited": True or False, # Output only. Some sleeps autodetected by algorithms can be manually edited by users.
+      "nap": True or False, # Output only. Naps are sleeps without stages and relatively short durations.
+      "processed": True or False, # Output only. Sleep and sleep stages algorithms finished processing.
+      "stagesStatus": "A String", # Output only. Sleep stages algorithm processing status.
+    },
+    "outOfBedSegments": [ # Optional. “Out of bed” segments that can overlap with sleep stages.
+      { # A time interval to represent an out-of-bed segment.
+        "endTime": "A String", # Required. Segment end time.
+        "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the segment relative to the Coordinated Universal Time (UTC).
+        "startTime": "A String", # Required. Segment tart time.
+        "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the segment relative to the Coordinated Universal Time (UTC).
+      },
+    ],
+    "stages": [ # Optional. List of non-overlapping contiguous sleep stage segments that cover the sleep period.
+      { # Sleep stage segment.
+        "createTime": "A String", # Output only. Creation time of this sleep stages segment.
+        "endTime": "A String", # Required. Sleep stage end time.
+        "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the sleep stage relative to the Coordinated Universal Time (UTC).
+        "startTime": "A String", # Required. Sleep stage start time.
+        "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the sleep stage relative to the Coordinated Universal Time (UTC).
+        "type": "A String", # Required. Sleep stage type: AWAKE, DEEP, REM, LIGHT etc.
+        "updateTime": "A String", # Output only. Last update time of this sleep stages segment.
+      },
+    ],
+    "summary": { #  Sleep summary: metrics and stages summary. # Output only. Sleep summary: metrics and stages summary.
+      "minutesAfterWakeUp": "A String", # Output only. Minutes after wake up calculated by restlessness algorithm.
+      "minutesAsleep": "A String", # Output only. Total number of minutes asleep. For classic sleep it is the sum of ASLEEP stages (excluding AWAKE and RESTLESS). For "stages" sleep it is the sum of LIGHT, REM and DEEP stages (excluding AWAKE).
+      "minutesAwake": "A String", # Output only. Total number of minutes awake. It is a sum of all AWAKE stages.
+      "minutesInSleepPeriod": "A String", # Output only. Delta between wake time and bedtime. It is the sum of all stages.
+      "minutesToFallAsleep": "A String", # Output only. Minutes to fall asleep calculated by restlessness algorithm.
+      "stagesSummary": [ # Output only. List of summaries (total duration and segment count) per each sleep stage type.
+        { # Total duration and segment count for a stage.
+          "count": "A String", # Output only. Number of sleep stages segments.
+          "minutes": "A String", # Output only. Total duration in minutes of a sleep stage.
+          "type": "A String", # Output only. Sleep stage type: AWAKE, DEEP, REM, LIGHT etc.
+        },
+      ],
+    },
+    "type": "A String", # Optional. SleepType: classic or stages.
+    "updateTime": "A String", # Output only. Last update time of this sleep observation.
+  },
+  "steps": { # Step count over the time interval. # Optional. Data for points in the `steps` interval data type collection.
+    "count": "A String", # Required. Number of steps in the recorded interval.
+    "interval": { # Represents a time interval of an observed data point. # Required. Observed interval.
+      "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval end time in civil time in the timezone the subject is in at the end of the observed interval
+        "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+          "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+          "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+          "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+        },
+        "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+          "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+          "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+          "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+          "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+        },
+      },
+      "civilStartTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval start time in civil time in the timezone the subject is in at the start of the observed interval
+        "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+          "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+          "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+          "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+        },
+        "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+          "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+          "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+          "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+          "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+        },
+      },
+      "endTime": "A String", # Required. Observed interval end time.
+      "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the observation relative to the Coordinated Universal Time (UTC).
+      "startTime": "A String", # Required. Observed interval start time.
+      "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the observation relative to the Coordinated Universal Time (UTC).
+    },
+  },
+  "timeInHeartRateZone": { # Time in heart rate zone record. It's an interval spent in specific heart rate zone. # Optional. Data for points in the `time-in-heart-rate-zone` interval data type collection.
+    "heartRateZoneType": "A String", # Required. Heart rate zone type.
+    "interval": { # Represents a time interval of an observed data point. # Required. Observed interval.
+      "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval end time in civil time in the timezone the subject is in at the end of the observed interval
+        "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+          "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+          "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+          "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+        },
+        "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+          "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+          "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+          "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+          "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+        },
+      },
+      "civilStartTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval start time in civil time in the timezone the subject is in at the start of the observed interval
+        "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+          "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+          "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+          "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+        },
+        "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+          "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+          "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+          "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+          "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+        },
+      },
+      "endTime": "A String", # Required. Observed interval end time.
+      "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the observation relative to the Coordinated Universal Time (UTC).
+      "startTime": "A String", # Required. Observed interval start time.
+      "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the observation relative to the Coordinated Universal Time (UTC).
+    },
+  },
+  "vo2Max": { # VO2 max measurement. # Optional. Data for points in the `vo2-max` sample data type collection.
+    "measurementMethod": "A String", # Optional. The method used to measure the VO2 max value.
+    "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which VO2 max was measured.
+      "civilTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. The civil time in the timezone the subject is in at the time of the observation.
+        "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+          "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+          "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+          "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+        },
+        "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+          "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+          "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+          "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+          "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+        },
+      },
+      "physicalTime": "A String", # Required. The time of the observation.
+      "utcOffset": "A String", # Required. The offset of the user's local time during the observation relative to the Coordinated Universal Time (UTC).
+    },
+    "vo2Max": 3.14, # Required. VO2 max value measured as in ml consumed oxygen / kg of body weight / min.
+  },
+  "weight": { # Body weight measurement. # Optional. Data for points in the `weight` sample data type collection.
+    "notes": "A String", # Optional. Standard free-form notes captured at manual logging.
+    "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which the weight was measured
+      "civilTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. The civil time in the timezone the subject is in at the time of the observation.
+        "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+          "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+          "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+          "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+        },
+        "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+          "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+          "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+          "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+          "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+        },
+      },
+      "physicalTime": "A String", # Required. The time of the observation.
+      "utcOffset": "A String", # Required. The offset of the user's local time during the observation relative to the Coordinated Universal Time (UTC).
+    },
+    "weightGrams": 3.14, # Required. Weight of a user in grams.
+  },
+}
+
+  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, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ dailyRollUp(parent, body=None, x__xgafv=None) +
Roll up data points over civil time intervals for supported data types.
+
+Args:
+  parent: string, Required. Parent data type of the Data Point collection. Format: `users/{user}/dataTypes/{data_type}`, e.g.: - `users/me/dataTypes/steps` - `users/me/dataTypes/distance` For a list of the supported data types see the DailyRollupDataPoint value union field. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request to roll up data points by civil time intervals.
+  "dataSourceFamily": "A String", # Optional. The data source family name to roll up. If empty, data points from all available data sources will be rolled up. Format: `users/me/dataSourceFamilies/{data_source_family}` The supported values are: - `users/me/dataSourceFamilies/all-sources` - default value - `users/me/dataSourceFamilies/google-wearables` - tracker devices - `users/me/dataSourceFamilies/google-sources` - Google first party sources
+  "pageSize": 42, # Optional. The maximum number of data points to return. If unspecified, at most 1440 data points will be returned. The maximum page size is 10000; values above that will be truncated accordingly.
+  "pageToken": "A String", # Optional. The `next_page_token` from a previous request, if any. All other request fields need to be the same as in the initial request when the page token is specified.
+  "range": { # Counterpart of google.type.Interval, but using CivilDateTime. # Required. Closed-open range of data points that will be rolled up. The start time must be aligned with the aggregation window. The maximum range for `calories-in-heart-rate-zone`, `heart-rate`, `active-minutes` and `total-calories` is 14 days. The maximum range for all other data types is 90 days.
+    "end": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Required. The exclusive end of the range.
+      "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+        "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+        "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+        "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+      },
+      "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+        "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+        "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+        "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+        "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+      },
+    },
+    "start": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Required. The inclusive start of the range.
+      "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+        "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+        "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+        "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+      },
+      "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+        "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+        "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+        "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+        "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+      },
+    },
+  },
+  "windowSizeDays": 42, # Optional. Aggregation window size, in number of days. Defaults to 1 if not specified.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response containing the list of rolled up data points.
+  "rollupDataPoints": [ # Values for each aggregation time window.
+    { # Value of a daily rollup for a single civil time interval (aggregation window)
+      "activeMinutes": { # Represents the result of the rollup of the active minutes data type. # Returned by default when rolling up data points from the `active-minutes` data type, or when requested explicitly using the `active-minutes` rollup type identifier.
+        "activeMinutesRollupByActivityLevel": [ # Active minutes by activity level. At most one record per activity level is allowed.
+          { # Active minutes by activity level.
+            "activeMinutesSum": "A String", # Number of whole minutes spent in activity.
+            "activityLevel": "A String", # The level of activity.
+          },
+        ],
+      },
+      "activeZoneMinutes": { # Represents the result of the rollup of the active zone minutes data type. # Returned by default when rolling up data points from the `active-zone-minutes` data type, or when requested explicitly using the `active-zone-minutes` rollup type identifier.
+        "sumInCardioHeartZone": "A String", # Active zone minutes in `HeartRateZone.CARDIO`.
+        "sumInFatBurnHeartZone": "A String", # Active zone minutes in `HeartRateZone.FAT_BURN`.
+        "sumInPeakHeartZone": "A String", # Active zone minutes in `HeartRateZone.PEAK`.
+      },
+      "activityLevel": { # Represents the result of the rollup of the activity level data type. # Returned by default when rolling up data points from the `activity-level` data type, or when requested explicitly using the `activity-level` rollup type identifier.
+        "activityLevelRollupsByActivityLevelType": [ # List of total durations in each activity level type.
+          { # Represents the total duration in a specific activity level type.
+            "activityLevelType": "A String", # Activity level type.
+            "totalDuration": "A String", # Total duration in the activity level type.
+          },
+        ],
+      },
+      "altitude": { # Represents the result of the rollup of the user's altitude. # Returned by default when rolling up data points from the `altitude` data type, or when requested explicitly using the `altitude` rollup type identifier.
+        "gainMillimetersSum": "A String", # Sum of the altitude gain in millimeters.
+      },
+      "bodyFat": { # Represents the result of the rollup of the body fat data type. # Returned by default when rolling up data points from the `body-fat` data type, or when requested explicitly using the `body-fat` rollup type identifier.
+        "bodyFatPercentageAvg": 3.14, # Average body fat percentage.
+      },
+      "caloriesInHeartRateZone": { # Represents the result of the rollup of the calories in heart rate zone data type. # Returned by default when rolling up data points from the `calories-in-heart-rate-zone` data type, or when requested explicitly using the `calories-in-heart-rate-zone` rollup type identifier.
+        "caloriesInHeartRateZones": [ # List of calories burned in each heart rate zone.
+          { # Represents the amount of kilocalories burned in a specific heart rate zone.
+            "heartRateZone": "A String", # The heart rate zone.
+            "kcal": 3.14, # The amount of kilocalories burned in the specified heart rate zone.
+          },
+        ],
+      },
+      "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # End time of the window this value aggregates over
+        "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+          "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+          "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+          "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+        },
+        "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+          "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+          "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+          "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+          "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+        },
+      },
+      "civilStartTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Start time of the window this value aggregates over
+        "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+          "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+          "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+          "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+        },
+        "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+          "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+          "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+          "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+          "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+        },
+      },
+      "distance": { # Result of the rollup of the user's distance. # Returned by default when rolling up data points from the `distance` data type, or when requested explicitly using the `distance` rollup type identifier.
+        "millimetersSum": "A String", # Sum of the distance in millimeters.
+      },
+      "floors": { # Represents the result of the rollup of the user's floors. # Returned by default when rolling up data points from the `floors` data type, or when requested explicitly using the `floors` rollup type identifier.
+        "countSum": "A String", # Sum of the floors count.
+      },
+      "heartRate": { # Represents the result of the rollup of the heart rate data type. # Returned by default when rolling up data points from the `heart-rate` data type, or when requested explicitly using the `heart-rate` rollup type identifier.
+        "beatsPerMinuteAvg": 3.14, # The average heart rate value in the interval.
+        "beatsPerMinuteMax": 3.14, # The maximum heart rate value in the interval.
+        "beatsPerMinuteMin": 3.14, # The minimum heart rate value in the interval.
+      },
+      "heartRateVariabilityPersonalRange": { # Represents the result of the rollup of the user's daily heart rate variability personal range. # Returned by default when rolling up data points from the `daily-heart-rate-variability` data type, or when requested explicitly using the `heart-rate-variability-personal-range` rollup type identifier.
+        "averageHeartRateVariabilityMillisecondsMax": 3.14, # The upper bound of the user's average heart rate variability personal range.
+        "averageHeartRateVariabilityMillisecondsMin": 3.14, # The lower bound of the user's average heart rate variability personal range.
+      },
+      "hydrationLog": { # Represents the result of the rollup of the hydration log data type. # Returned by default when rolling up data points from the `hydration-log` data type, or when requested explicitly using the `hydration-log` rollup type identifier.
+        "amountConsumed": { # Rollup for volume quantity. # Rollup for amount consumed.
+          "millilitersSum": 3.14, # Required. The sum of volume in milliliters.
+          "userProvidedUnitLast": "A String", # Optional. The user provided unit on the last element.
+        },
+      },
+      "restingHeartRatePersonalRange": { # Represents the rollup value for the daily resting heart rate data type. # Returned by default when rolling up data points from the `daily-resting-heart-rate` data type, or when requested explicitly using the `resting-heart-rate-personal-range` rollup type identifier.
+        "beatsPerMinuteMax": 3.14, # The upper bound of the user's daily resting heart rate personal range.
+        "beatsPerMinuteMin": 3.14, # The lower bound of the user's daily resting heart rate personal range.
+      },
+      "runVo2Max": { # Represents the result of the rollup of the user's daily heart rate variability personal range. # Returned by default when rolling up data points from the `run-vo2-max` data type, or when requested explicitly using the `run-vo2-max` rollup type identifier.
+        "rateAvg": 3.14, # Average value of run VO2 max in the interval.
+        "rateMax": 3.14, # Maximum value of run VO2 max in the interval.
+        "rateMin": 3.14, # Minimum value of run VO2 max in the interval..
+      },
+      "sedentaryPeriod": { # Represents the result of the rollup of the user's sedentary periods. # Returned by default when rolling up data points from the `sedentary-period` data type, or when requested explicitly using the `sedentary-period` rollup type identifier.
+        "durationSum": "A String", # The total time user spent sedentary during the interval.
+      },
+      "steps": { # Represents the result of the rollup of the steps data type. # Returned by default when rolling up data points from the `steps` data type, or when requested explicitly using the `steps` rollup type identifier.
+        "countSum": "A String", # Total number of steps in the interval.
+      },
+      "timeInHeartRateZone": { # Represents the result of the rollup of the time in heart rate zone data type. # Returned by default when rolling up data points from the `time-in-heart-rate-zone` data type, or when requested explicitly using the `time-in-heart-rate-zone` rollup type identifier.
+        "timeInHeartRateZones": [ # List of time spent in each heart rate zone.
+          { # Represents the total time spent in a specific heart rate zone.
+            "duration": "A String", # The total time spent in the specified heart rate zone.
+            "heartRateZone": "A String", # The heart rate zone.
+          },
+        ],
+      },
+      "totalCalories": { # Represents the result of the rollup of the user's total calories. # Returned by default when rolling up data points from the `total-calories` data type, or when requested explicitly using the `total-calories` rollup type identifier.
+        "kcalSum": 3.14, # Sum of the total calories in kilocalories.
+      },
+      "weight": { # Represents the result of the rollup of the weight data type. # Returned by default when rolling up data points from the `weight` data type, or when requested explicitly using the `weight` rollup type identifier.
+        "weightGramsAvg": 3.14, # Average weight in grams.
+      },
+    },
+  ],
+}
+
+ +
+ exportExerciseTcx(name, partialData=None, x__xgafv=None) +
Exports exercise data in TCX format. Note: While the Authorization section below states that any one of the listed scopes is accepted, this specific method requires the user to provide both one of the `activity_and_fitness` scopes (`normal` or `readonly`) AND one of the `location` scopes (`normal` or `readonly`) in their access token to succeed.
+
+Args:
+  name: string, Required. The resource name of the exercise data point to export. Format: `users/{user}/dataTypes/exercise/dataPoints/{data_point}` Example: `users/me/dataTypes/exercise/dataPoints/2026443605080188808` The `{user}` is the alias `"me"` currently. Future versions may support user IDs. The `{data_point}` ID maps to the exercise ID, which is a long integer. (required)
+  partialData: boolean, Optional. Indicates whether to include the TCX data points when the GPS data is not available. If not specified, defaults to `false` and partial data will not be included.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents a Response for exporting exercise data in TCX format.
+  "tcxData": "A String", # Contains the exported TCX data.
+}
+
+ +
+ exportExerciseTcx_media(name, partialData=None, x__xgafv=None) +
Exports exercise data in TCX format. Note: While the Authorization section below states that any one of the listed scopes is accepted, this specific method requires the user to provide both one of the `activity_and_fitness` scopes (`normal` or `readonly`) AND one of the `location` scopes (`normal` or `readonly`) in their access token to succeed.
+
+Args:
+  name: string, Required. The resource name of the exercise data point to export. Format: `users/{user}/dataTypes/exercise/dataPoints/{data_point}` Example: `users/me/dataTypes/exercise/dataPoints/2026443605080188808` The `{user}` is the alias `"me"` currently. Future versions may support user IDs. The `{data_point}` ID maps to the exercise ID, which is a long integer. (required)
+  partialData: boolean, Optional. Indicates whether to include the TCX data points when the GPS data is not available. If not specified, defaults to `false` and partial data will not be included.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  The media object as a string.
+
+    
+
+ +
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) +
Query user health and fitness data points.
+
+Args:
+  parent: string, Required. Parent data type of the Data Point collection. Format: `users/me/dataTypes/{data_type}`, e.g.: - `users/me/dataTypes/steps` - `users/me/dataTypes/weight` For a list of the supported data types see the DataPoint data union field. (required)
+  filter: string, Optional. Filter expression following https://google.aip.dev/160. A time range (either physical or civil) can be specified. The supported filter fields are: - Interval start time: - Pattern: `{interval_data_type}.interval.start_time` - Supported comparison operators: `>=`, `<` - Timestamp literal expected in RFC-3339 format - Supported logical operators: `AND` - Example: - `steps.interval.start_time >= "2023-11-24T00:00:00Z" AND steps.interval.start_time < "2023-11-25T00:00:00Z"` - `distance.interval.start_time >= "2024-08-14T12:34:56Z"` - Interval civil start time: - Pattern: `{interval_data_type}.interval.civil_start_time` - Supported comparison operators: `>=`, `<` - Date with optional time literal expected in ISO 8601 `YYYY-MM-DD[THH:mm:ss]` format - Supported logical operators: `AND` - Example: - `steps.interval.civil_start_time >= "2023-11-24" AND steps.interval.civil_start_time < "2023-11-25"` - `distance.interval.civil_start_time >= "2024-08-14T12:34:56"` - Sample observation physical time: - Pattern: `{sample_data_type}.sample_time.physical_time` - Supported comparison operators: `>=`, `<` - Timestamp literal expected in RFC-3339 format - Supported logical operators: `AND` - Example: - `weight.sample_time.physical_time >= "2023-11-24T00:00:00Z" AND weight.sample_time.physical_time < "2023-11-25T00:00:00Z"` - `weight.sample_time.physical_time >= "2024-08-14T12:34:56Z"` - Sample observation civil time: - Pattern: `{sample_data_type}.sample_time.civil_time` - Supported comparison operators: `>=`, `<` - Date with optional time literal expected in ISO 8601 `YYYY-MM-DD[THH:mm:ss]` format - Supported logical operators: `AND` - Example: - `weight.sample_time.civil_time >= "2023-11-24" AND weight.sample_time.civil_time < "2023-11-25"` - `weight.sample_time.civil_time >= "2024-08-14T12:34:56"` - Daily summary date: - Pattern: `{daily_summary_data_type}.date` - Supported comparison operators: `>=`, `<` - Date literal expected in ISO 8601 `YYYY-MM-DD` format - Supported logical operators: `AND` - Example: - `daily_resting_heart_rate.date >= "2024-08-14"` - `daily_heart_rate_variability.date < "2024-08-15"` - Session civil start time (**Excluding Sleep**): - Pattern: `{session_data_type}.interval.civil_start_time` - Supported comparison operators: `>=`, `<` - Date with optional time literal expected in ISO 8601 `YYYY-MM-DD[THH:mm:ss]` format - Supported logical operators: `AND` - Example: - `exercise.interval.civil_start_time >= "2023-11-24" AND exercise.interval.civil_start_time < "2023-11-25"` - `exercise.interval.civil_start_time >= "2024-08-14T12:34:56"` - Session end time (**Sleep specific**): - Pattern: `sleep.interval.end_time` - Supported comparison operators: `>=`, `<` - Timestamp literal expected in RFC-3339 format - Supported logical operators: `AND`, `OR` - Example: - `sleep.interval.end_time >= "2023-11-24T00:00:00Z" AND sleep.interval.end_time < "2023-11-25T00:00:00Z"` - Session civil end time (**Sleep specific**): - Pattern: `sleep.interval.civil_end_time` - Supported comparison operators: `>=`, `<` - Date with optional time literal expected in ISO 8601 `YYYY-MM-DD[THH:mm:ss]` format - Supported logical operators: `AND`, `OR` - Example: - `sleep.interval.civil_end_time >= "2023-11-24" AND sleep.interval.civil_end_time < "2023-11-25"` Data points in the response will be ordered by the interval start time in descending order.
+  pageSize: integer, Optional. The maximum number of data points to return. If unspecified, at most 1440 data points will be returned. The maximum page size is 10000; values above that will be truncated accordingly. For `exercise` and `sleep` the default page size is 25. The maximum page size for `exercise` and `sleep` is 25.
+  pageToken: string, Optional. The `next_page_token` from a previous request, if any.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response containing raw data points matching the query
+  "dataPoints": [ # Data points matching the query
+    { # A computed or recorded metric.
+      "activeMinutes": { # Record of active minutes in a given time interval. # Optional. Data for points in the `active-minutes` interval data type collection.
+        "activeMinutesByActivityLevel": [ # Required. Active minutes by activity level. At most one record per activity level is allowed.
+          { # Active minutes at a given activity level.
+            "activeMinutes": "A String", # Required. Number of whole minutes spent in activity.
+            "activityLevel": "A String", # Required. The level of activity.
+          },
+        ],
+        "interval": { # Represents a time interval of an observed data point. # Required. Observed interval.
+          "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval end time in civil time in the timezone the subject is in at the end of the observed interval
+            "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+              "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+              "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+              "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+            },
+            "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+              "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+              "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+              "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+          },
+          "civilStartTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval start time in civil time in the timezone the subject is in at the start of the observed interval
+            "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+              "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+              "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+              "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+            },
+            "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+              "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+              "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+              "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+          },
+          "endTime": "A String", # Required. Observed interval end time.
+          "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the observation relative to the Coordinated Universal Time (UTC).
+          "startTime": "A String", # Required. Observed interval start time.
+          "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the observation relative to the Coordinated Universal Time (UTC).
+        },
+      },
+      "activeZoneMinutes": { # Record of active zone minutes in a given time interval. # Optional. Data for points in the `active-zone-minutes` interval data type collection, measured in minutes.
+        "activeZoneMinutes": "A String", # Required. Number of Active Zone Minutes earned in the given time interval. Note: active_zone_minutes equals to 1 for low intensity (fat burn) zones or 2 for high intensity zones (cardio, peak).
+        "heartRateZone": "A String", # Required. Heart rate zone in which the active zone minutes have been earned, in the given time interval.
+        "interval": { # Represents a time interval of an observed data point. # Required. Observed interval.
+          "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval end time in civil time in the timezone the subject is in at the end of the observed interval
+            "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+              "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+              "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+              "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+            },
+            "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+              "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+              "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+              "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+          },
+          "civilStartTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval start time in civil time in the timezone the subject is in at the start of the observed interval
+            "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+              "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+              "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+              "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+            },
+            "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+              "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+              "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+              "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+          },
+          "endTime": "A String", # Required. Observed interval end time.
+          "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the observation relative to the Coordinated Universal Time (UTC).
+          "startTime": "A String", # Required. Observed interval start time.
+          "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the observation relative to the Coordinated Universal Time (UTC).
+        },
+      },
+      "activityLevel": { # Internal type to capture activity level during a certain time interval. # Optional. Data for points in the `activity-level` daily data type collection.
+        "activityLevelType": "A String", # Required. Activity level type in the given time interval.
+        "interval": { # Represents a time interval of an observed data point. # Required. Observed interval.
+          "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval end time in civil time in the timezone the subject is in at the end of the observed interval
+            "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+              "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+              "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+              "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+            },
+            "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+              "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+              "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+              "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+          },
+          "civilStartTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval start time in civil time in the timezone the subject is in at the start of the observed interval
+            "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+              "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+              "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+              "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+            },
+            "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+              "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+              "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+              "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+          },
+          "endTime": "A String", # Required. Observed interval end time.
+          "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the observation relative to the Coordinated Universal Time (UTC).
+          "startTime": "A String", # Required. Observed interval start time.
+          "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the observation relative to the Coordinated Universal Time (UTC).
+        },
+      },
+      "altitude": { # Captures the altitude gain (i.e. deltas), and not level above sea, for a user in millimeters. # Optional. Data for points in the `altitude` interval data type collection.
+        "gainMillimeters": "A String", # Required. Altitude gain in millimeters over the observed interval.
+        "interval": { # Represents a time interval of an observed data point. # Required. Observed interval.
+          "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval end time in civil time in the timezone the subject is in at the end of the observed interval
+            "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+              "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+              "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+              "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+            },
+            "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+              "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+              "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+              "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+          },
+          "civilStartTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval start time in civil time in the timezone the subject is in at the start of the observed interval
+            "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+              "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+              "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+              "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+            },
+            "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+              "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+              "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+              "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+          },
+          "endTime": "A String", # Required. Observed interval end time.
+          "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the observation relative to the Coordinated Universal Time (UTC).
+          "startTime": "A String", # Required. Observed interval start time.
+          "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the observation relative to the Coordinated Universal Time (UTC).
+        },
+      },
+      "bodyFat": { # Body fat measurement. # Optional. Data for points in the `body-fat` sample data type collection.
+        "percentage": 3.14, # Required. Body fat percentage, in range [0, 100].
+        "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which body fat was measured.
+          "civilTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. The civil time in the timezone the subject is in at the time of the observation.
+            "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+              "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+              "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+              "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+            },
+            "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+              "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+              "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+              "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+          },
+          "physicalTime": "A String", # Required. The time of the observation.
+          "utcOffset": "A String", # Required. The offset of the user's local time during the observation relative to the Coordinated Universal Time (UTC).
+        },
+      },
+      "dailyHeartRateVariability": { # Represents the daily heart rate variability data type. At least one of the following fields must be set: - `average_heart_rate_variability_milliseconds` - `non_rem_heart_rate_beats_per_minute` - `entropy` - `deep_sleep_root_mean_square_of_successive_differences_milliseconds` # Optional. Data for points in the `daily-heart-rate-variability` daily data type collection.
+        "averageHeartRateVariabilityMilliseconds": 3.14, # Optional. A user's average heart rate variability calculated using the root mean square of successive differences (RMSSD) in times between heartbeats.
+        "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Date (in the user's timezone) of heart rate variability measurement.
+          "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+          "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+          "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+        },
+        "deepSleepRootMeanSquareOfSuccessiveDifferencesMilliseconds": 3.14, # Optional. The root mean square of successive differences (RMSSD) value during deep sleep.
+        "entropy": 3.14, # Optional. The Shanon entropy of heartbeat intervals. Entropy quantifies randomness or disorder in a system. High entropy indicates high HRV. Entropy is measured from the histogram of time interval between successive heart beats values measured during sleep.
+        "nonRemHeartRateBeatsPerMinute": "A String", # Optional. Non-REM heart rate
+      },
+      "dailyHeartRateZones": { # User's heart rate zone thresholds based on the Karvonen algorithm for a specific day. # Optional. Data for points in the `daily-heart-rate-zones` daily data type collection.
+        "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Date (in user's timezone) of the heart rate zones record.
+          "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+          "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+          "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+        },
+        "heartRateZones": [ # Required. The heart rate zones.
+          { # The heart rate zone.
+            "heartRateZoneType": "A String", # Required. The heart rate zone type.
+            "maxBeatsPerMinute": "A String", # Required. Maximum heart rate for this zone in beats per minute.
+            "minBeatsPerMinute": "A String", # Required. Minimum heart rate for this zone in beats per minute.
+          },
+        ],
+      },
+      "dailyOxygenSaturation": { # A daily oxygen saturation (SpO2) record. Represents the user's daily oxygen saturation summary, typically calculated during sleep. # Optional. Data for points in the `daily-oxygen-saturation` daily data type collection.
+        "averagePercentage": 3.14, # Required. The average value of the oxygen saturation samples during the sleep.
+        "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Date (in user's timezone) of the daily oxygen saturation record.
+          "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+          "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+          "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+        },
+        "lowerBoundPercentage": 3.14, # Required. The lower bound of the confidence interval of oxygen saturation samples during sleep.
+        "standardDeviationPercentage": 3.14, # Optional. Standard deviation of the daily oxygen saturation averages from the past 7-30 days.
+        "upperBoundPercentage": 3.14, # Required. The upper bound of the confidence interval of oxygen saturation samples during sleep.
+      },
+      "dailyRespiratoryRate": { # A daily average respiratory rate (breaths per minute) for a day of the year. One data point per day calculated for the main sleep. # Optional. Data for points in the `daily-respiratory-rate` daily data type collection.
+        "breathsPerMinute": 3.14, # Required. The average number of breaths taken per minute.
+        "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. The date on which the respiratory rate was measured.
+          "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+          "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+          "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+        },
+      },
+      "dailyRestingHeartRate": { # Measures the daily resting heart rate for a user, calculated using the all day heart rate measurements. # Optional. Data for points in the `daily-resting-heart-rate` daily data type collection.
+        "beatsPerMinute": "A String", # Required. The resting heart rate value in beats per minute.
+        "dailyRestingHeartRateMetadata": { # Metadata for the daily resting heart rate. # Optional. Metadata for the daily resting heart rate.
+          "calculationMethod": "A String", # Required. The method used to calculate the resting heart rate.
+        },
+        "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Date (in the user's timezone) of the resting heart rate measurement.
+          "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+          "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+          "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+        },
+      },
+      "dailySleepTemperatureDerivations": { # Provides derived sleep temperature values, calculated from skin or internal device temperature readings during sleep. # Optional. Data for points in the `daily-sleep-temperature-derivations` daily data type collection.
+        "baselineTemperatureCelsius": 3.14, # Optional. The user's baseline skin temperature. It is the median of the user's nightly skin temperature over the past 30 days.
+        "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Date for which the sleep temperature derivations are calculated.
+          "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+          "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+          "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+        },
+        "nightlyTemperatureCelsius": 3.14, # Required. The user's nightly skin temperature. It is the mean of skin temperature samples taken from the user’s sleep.
+        "relativeNightlyStddev30dCelsius": 3.14, # Optional. The standard deviation of the user’s relative nightly skin temperature (temperature - baseline) over the past 30 days.
+      },
+      "dailyVo2Max": { # Contains a daily summary of the user's VO2 max (cardio fitness score), which is the maximum rate of oxygen the body can use during exercise. # Optional. Data for points in the `daily-vo2-max` daily data type collection.
+        "cardioFitnessLevel": "A String", # Optional. Represents the user's cardio fitness level based on their VO2 max.
+        "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. The date for which the Daily VO2 max was measured.
+          "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+          "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+          "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+        },
+        "estimated": True or False, # Optional. An estimated field is added to indicate when the confidence has decreased sufficiently to consider the value an estimation.
+        "vo2Max": 3.14, # Required. Daily VO2 max value measured as in ml consumed oxygen / kg of body weight / min.
+        "vo2MaxCovariance": 3.14, # Optional. The covariance of the VO2 max value.
+      },
+      "dataSource": { # Data Source definition to track the origin of data. Each health data point, regardless of the complexity or data model (whether a simple step count or a detailed sleep session) must retain information about its source of origin (e.g. the device or app that collected it). # Optional. Data source information for the metric
+        "application": { # Optional metadata for the application that provided this data. # Output only. Captures metadata for the application that provided this data.
+          "googleWebClientId": "A String", # Output only. The Google OAuth 2.0 client ID of the web application or service that recorded the data. This is the client ID used during the Google OAuth flow to obtain user credentials. This field is system-populated when the data is uploaded from Google Web API.
+          "packageName": "A String", # Output only. A unique identifier for the mobile application that was the source of the data. This is typically the application's package name on Android (e.g., `com.google.fitbit`) or the bundle ID on iOS. This field is informational and helps trace data origin. This field is system-populated when the data is uploaded from the Fitbit mobile application, Health Connect or Health Kit.
+          "webClientId": "A String", # Output only. The client ID of the application that recorded the data. This ID is a legacy Fitbit API client ID, which is different from a Google OAuth client ID. Example format: `ABC123`. This field is system-populated and used for tracing data from legacy Fitbit API integrations. This field is system-populated when the data is uploaded from a legacy Fitbit API integration.
+        },
+        "device": { # Captures metadata about the device that recorded the measurement. # Optional. Captures metadata for raw data points originating from devices. We expect this data source to be used for data points written on device sync.
+          "displayName": "A String", # Optional. An optional name for the device.
+          "formFactor": "A String", # Optional. Captures the form factor of the device.
+          "manufacturer": "A String", # Optional. An optional manufacturer of the device.
+        },
+        "platform": "A String", # Output only. Captures the platform that uploaded the data.
+        "recordingMethod": "A String", # Optional. Captures how the data was recorded.
+      },
+      "distance": { # Distance traveled over an interval of time. # Optional. Data for points in the `distance` interval data type collection.
+        "interval": { # Represents a time interval of an observed data point. # Required. Observed interval.
+          "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval end time in civil time in the timezone the subject is in at the end of the observed interval
+            "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+              "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+              "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+              "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+            },
+            "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+              "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+              "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+              "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+          },
+          "civilStartTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval start time in civil time in the timezone the subject is in at the start of the observed interval
+            "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+              "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+              "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+              "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+            },
+            "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+              "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+              "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+              "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+          },
+          "endTime": "A String", # Required. Observed interval end time.
+          "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the observation relative to the Coordinated Universal Time (UTC).
+          "startTime": "A String", # Required. Observed interval start time.
+          "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the observation relative to the Coordinated Universal Time (UTC).
+        },
+        "millimeters": "A String", # Required. Distance in millimeters over the observed interval.
+      },
+      "exercise": { # An exercise that stores information about a physical activity. # Optional. Data for points in the `exercise` session data type collection.
+        "activeDuration": "A String", # Optional. Duration excluding pauses.
+        "createTime": "A String", # Output only. Represents the timestamp of the creation of the exercise.
+        "displayName": "A String", # Required. Exercise display name.
+        "exerciseEvents": [ # Optional. Exercise events that happen during an exercise, such as pause & restarts.
+          { # Represents instantaneous events that happen during an exercise, such as start, stop, pause, split.
+            "eventTime": "A String", # Required. Exercise event time
+            "eventUtcOffset": "A String", # Required. Exercise event time offset from UTC
+            "exerciseEventType": "A String", # Required. The type of the event, such as start, stop, pause, resume.
+          },
+        ],
+        "exerciseMetadata": { # Additional exercise metadata. # Optional. Additional exercise metadata.
+          "hasGps": True or False, # Optional. Whether the exercise had GPS tracking.
+          "poolLengthMillimeters": "A String", # Optional. Pool length in millimeters. Only present in the swimming exercises.
+        },
+        "exerciseType": "A String", # Required. The type of activity performed during an exercise.
+        "interval": { # Represents a time interval of session data point, which bundles multiple observed metrics together. # Required. Observed exercise interval
+          "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Session end time in civil time in the timezone the subject is in at the end of the session.
+            "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+              "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+              "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+              "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+            },
+            "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+              "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+              "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+              "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+          },
+          "civilStartTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Session start time in civil time in the timezone the subject is in at the start of the session.
+            "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+              "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+              "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+              "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+            },
+            "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+              "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+              "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+              "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+          },
+          "endTime": "A String", # Required. The end time of the observed session.
+          "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the session relative to the Coordinated Universal Time (UTC).
+          "startTime": "A String", # Required. The start time of the observed session.
+          "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the session relative to the Coordinated Universal Time (UTC).
+        },
+        "metricsSummary": { # Summary metrics for an exercise. # Required. Summary metrics for this exercise ( )
+          "activeZoneMinutes": "A String", # Optional. Total active zone minutes for the exercise.
+          "averageHeartRateBeatsPerMinute": "A String", # Optional. Average heart rate during the exercise.
+          "averagePaceSecondsPerMeter": 3.14, # Optional. Average pace in seconds per meter.
+          "averageSpeedMillimetersPerSecond": 3.14, # Optional. Average speed in millimeters per second.
+          "caloriesKcal": 3.14, # Optional. Total calories burned by the user during the exercise.
+          "distanceMillimeters": 3.14, # Optional. Total distance covered by the user during the exercise.
+          "elevationGainMillimeters": 3.14, # Optional. Total elevation gain during the exercise.
+          "heartRateZoneDurations": { # Time spent in each heart rate zone. # Optional. Time spent in each heart rate zone.
+            "lightTime": "A String", # Optional. Time spent in light heart rate zone.
+            "moderateTime": "A String", # Optional. Time spent in moderate heart rate zone.
+            "peakTime": "A String", # Optional. Time spent in peak heart rate zone.
+            "vigorousTime": "A String", # Optional. Time spent in vigorous heart rate zone.
+          },
+          "mobilityMetrics": { # Mobility workouts specific metrics # Optional. Mobility workouts specific metrics. Only present in the advanced running exercises.
+            "avgCadenceStepsPerMinute": 3.14, # Optional. Cadence is a measure of the frequency of your foot strikes. Steps / min in real time during workout.
+            "avgGroundContactTimeDuration": "A String", # Optional. The ground contact time for a particular stride is the amount of time for which the foot was in contact with the ground on that stride
+            "avgStrideLengthMillimeters": "A String", # Optional. Stride length is a measure of the distance covered by a single stride
+            "avgVerticalOscillationMillimeters": "A String", # Optional. Distance off the ground your center of mass moves with each stride while running
+            "avgVerticalRatio": 3.14, # Optional. Vertical oscillation/stride length between [5.0, 11.0].
+          },
+          "runVo2Max": 3.14, # Optional. Run VO2 max value for the exercise. Only present in the running exercises at the top level as in the summary of the whole exercise.
+          "steps": "A String", # Optional. Total steps taken during the exercise.
+          "totalSwimLengths": 3.14, # Optional. Number of full pool lengths completed during the exercise. Only present in the swimming exercises at the top level as in the summary of the whole exercise.
+        },
+        "notes": "A String", # Optional. Standard free-form notes captured at manual logging.
+        "splitSummaries": [ # Optional. Laps or splits recorded within an exercise. Laps could be split based on distance or other criteria (duration, etc.) Laps should not be overlapping with each other.
+          { # Represents splits or laps recorded within an exercise. Lap events partition a workout into segments based on criteria like distance, time, or calories.
+            "activeDuration": "A String", # Output only. Lap time excluding the pauses.
+            "endTime": "A String", # Required. Lap end time
+            "endUtcOffset": "A String", # Required. Lap end time offset from UTC
+            "metricsSummary": { # Summary metrics for an exercise. # Required. Summary metrics for this split.
+              "activeZoneMinutes": "A String", # Optional. Total active zone minutes for the exercise.
+              "averageHeartRateBeatsPerMinute": "A String", # Optional. Average heart rate during the exercise.
+              "averagePaceSecondsPerMeter": 3.14, # Optional. Average pace in seconds per meter.
+              "averageSpeedMillimetersPerSecond": 3.14, # Optional. Average speed in millimeters per second.
+              "caloriesKcal": 3.14, # Optional. Total calories burned by the user during the exercise.
+              "distanceMillimeters": 3.14, # Optional. Total distance covered by the user during the exercise.
+              "elevationGainMillimeters": 3.14, # Optional. Total elevation gain during the exercise.
+              "heartRateZoneDurations": { # Time spent in each heart rate zone. # Optional. Time spent in each heart rate zone.
+                "lightTime": "A String", # Optional. Time spent in light heart rate zone.
+                "moderateTime": "A String", # Optional. Time spent in moderate heart rate zone.
+                "peakTime": "A String", # Optional. Time spent in peak heart rate zone.
+                "vigorousTime": "A String", # Optional. Time spent in vigorous heart rate zone.
+              },
+              "mobilityMetrics": { # Mobility workouts specific metrics # Optional. Mobility workouts specific metrics. Only present in the advanced running exercises.
+                "avgCadenceStepsPerMinute": 3.14, # Optional. Cadence is a measure of the frequency of your foot strikes. Steps / min in real time during workout.
+                "avgGroundContactTimeDuration": "A String", # Optional. The ground contact time for a particular stride is the amount of time for which the foot was in contact with the ground on that stride
+                "avgStrideLengthMillimeters": "A String", # Optional. Stride length is a measure of the distance covered by a single stride
+                "avgVerticalOscillationMillimeters": "A String", # Optional. Distance off the ground your center of mass moves with each stride while running
+                "avgVerticalRatio": 3.14, # Optional. Vertical oscillation/stride length between [5.0, 11.0].
+              },
+              "runVo2Max": 3.14, # Optional. Run VO2 max value for the exercise. Only present in the running exercises at the top level as in the summary of the whole exercise.
+              "steps": "A String", # Optional. Total steps taken during the exercise.
+              "totalSwimLengths": 3.14, # Optional. Number of full pool lengths completed during the exercise. Only present in the swimming exercises at the top level as in the summary of the whole exercise.
+            },
+            "splitType": "A String", # Required. Method used to split the exercise laps. Users may manually mark the lap as complete even if the tracking is automatic.
+            "startTime": "A String", # Required. Lap start time
+            "startUtcOffset": "A String", # Required. Lap start time offset from UTC
+          },
+        ],
+        "splits": [ # Optional. The default split is 1 km or 1 mile. - if the movement distance is less than the default, then there are no splits - if the movement distance is greater than or equal to the default, then we have splits
+          { # Represents splits or laps recorded within an exercise. Lap events partition a workout into segments based on criteria like distance, time, or calories.
+            "activeDuration": "A String", # Output only. Lap time excluding the pauses.
+            "endTime": "A String", # Required. Lap end time
+            "endUtcOffset": "A String", # Required. Lap end time offset from UTC
+            "metricsSummary": { # Summary metrics for an exercise. # Required. Summary metrics for this split.
+              "activeZoneMinutes": "A String", # Optional. Total active zone minutes for the exercise.
+              "averageHeartRateBeatsPerMinute": "A String", # Optional. Average heart rate during the exercise.
+              "averagePaceSecondsPerMeter": 3.14, # Optional. Average pace in seconds per meter.
+              "averageSpeedMillimetersPerSecond": 3.14, # Optional. Average speed in millimeters per second.
+              "caloriesKcal": 3.14, # Optional. Total calories burned by the user during the exercise.
+              "distanceMillimeters": 3.14, # Optional. Total distance covered by the user during the exercise.
+              "elevationGainMillimeters": 3.14, # Optional. Total elevation gain during the exercise.
+              "heartRateZoneDurations": { # Time spent in each heart rate zone. # Optional. Time spent in each heart rate zone.
+                "lightTime": "A String", # Optional. Time spent in light heart rate zone.
+                "moderateTime": "A String", # Optional. Time spent in moderate heart rate zone.
+                "peakTime": "A String", # Optional. Time spent in peak heart rate zone.
+                "vigorousTime": "A String", # Optional. Time spent in vigorous heart rate zone.
+              },
+              "mobilityMetrics": { # Mobility workouts specific metrics # Optional. Mobility workouts specific metrics. Only present in the advanced running exercises.
+                "avgCadenceStepsPerMinute": 3.14, # Optional. Cadence is a measure of the frequency of your foot strikes. Steps / min in real time during workout.
+                "avgGroundContactTimeDuration": "A String", # Optional. The ground contact time for a particular stride is the amount of time for which the foot was in contact with the ground on that stride
+                "avgStrideLengthMillimeters": "A String", # Optional. Stride length is a measure of the distance covered by a single stride
+                "avgVerticalOscillationMillimeters": "A String", # Optional. Distance off the ground your center of mass moves with each stride while running
+                "avgVerticalRatio": 3.14, # Optional. Vertical oscillation/stride length between [5.0, 11.0].
+              },
+              "runVo2Max": 3.14, # Optional. Run VO2 max value for the exercise. Only present in the running exercises at the top level as in the summary of the whole exercise.
+              "steps": "A String", # Optional. Total steps taken during the exercise.
+              "totalSwimLengths": 3.14, # Optional. Number of full pool lengths completed during the exercise. Only present in the swimming exercises at the top level as in the summary of the whole exercise.
+            },
+            "splitType": "A String", # Required. Method used to split the exercise laps. Users may manually mark the lap as complete even if the tracking is automatic.
+            "startTime": "A String", # Required. Lap start time
+            "startUtcOffset": "A String", # Required. Lap start time offset from UTC
+          },
+        ],
+        "updateTime": "A String", # Output only. This is the timestamp of the last update to the exercise.
+      },
+      "floors": { # Gained elevation measured in floors over the time interval # Optional. Data for points in the `floors` interval data type collection.
+        "count": "A String", # Required. Number of floors in the recorded interval
+        "interval": { # Represents a time interval of an observed data point. # Required. Observed interval
+          "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval end time in civil time in the timezone the subject is in at the end of the observed interval
+            "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+              "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+              "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+              "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+            },
+            "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+              "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+              "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+              "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+          },
+          "civilStartTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval start time in civil time in the timezone the subject is in at the start of the observed interval
+            "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+              "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+              "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+              "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+            },
+            "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+              "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+              "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+              "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+          },
+          "endTime": "A String", # Required. Observed interval end time.
+          "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the observation relative to the Coordinated Universal Time (UTC).
+          "startTime": "A String", # Required. Observed interval start time.
+          "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the observation relative to the Coordinated Universal Time (UTC).
+        },
+      },
+      "heartRate": { # A heart rate measurement. # Optional. Data for points in the `heart-rate` sample data type collection.
+        "beatsPerMinute": "A String", # Required. The heart rate value in beats per minute.
+        "metadata": { # Heart rate metadata. # Optional. Metadata about the heart rate sample.
+          "motionContext": "A String", # Optional. Indicates the user’s level of activity when the heart rate sample was measured
+          "sensorLocation": "A String", # Optional. Indicates the location of the sensor that measured the heart rate.
+        },
+        "sampleTime": { # Represents a sample time of an observed data point. # Required. Observation time
+          "civilTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. The civil time in the timezone the subject is in at the time of the observation.
+            "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+              "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+              "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+              "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+            },
+            "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+              "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+              "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+              "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+          },
+          "physicalTime": "A String", # Required. The time of the observation.
+          "utcOffset": "A String", # Required. The offset of the user's local time during the observation relative to the Coordinated Universal Time (UTC).
+        },
+      },
+      "heartRateVariability": { # Captures user's heart rate variability (HRV) as measured by the root mean square of successive differences (RMSSD) between normal heartbeats or by standard deviation of the inter-beat intervals (SDNN). # Optional. Data for points in the `heart-rate-variability` sample data type collection.
+        "rootMeanSquareOfSuccessiveDifferencesMilliseconds": 3.14, # Optional. The root mean square of successive differences between normal heartbeats. This is a measure of heart rate variability used by Fitbit.
+        "sampleTime": { # Represents a sample time of an observed data point. # Required. The time of the heart rate variability measurement.
+          "civilTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. The civil time in the timezone the subject is in at the time of the observation.
+            "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+              "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+              "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+              "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+            },
+            "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+              "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+              "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+              "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+          },
+          "physicalTime": "A String", # Required. The time of the observation.
+          "utcOffset": "A String", # Required. The offset of the user's local time during the observation relative to the Coordinated Universal Time (UTC).
+        },
+        "standardDeviationMilliseconds": 3.14, # Optional. The standard deviation of the heart rate variability measurement.
+      },
+      "hydrationLog": { # Holds information about a user logged hydration. # Optional. Data for points in the `hydration-log` session data type collection.
+        "amountConsumed": { # Represents the volume quantity. # Required. Amount of liquid (ex. water) consumed.
+          "milliliters": 3.14, # Required. Value representing the volume in milliliters.
+          "userProvidedUnit": "A String", # Optional. Value representing the user provided unit.
+        },
+        "interval": { # Represents a time interval of session data point, which bundles multiple observed metrics together. # Required. Observed interval.
+          "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Session end time in civil time in the timezone the subject is in at the end of the session.
+            "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+              "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+              "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+              "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+            },
+            "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+              "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+              "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+              "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+          },
+          "civilStartTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Session start time in civil time in the timezone the subject is in at the start of the session.
+            "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+              "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+              "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+              "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+            },
+            "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+              "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+              "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+              "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+          },
+          "endTime": "A String", # Required. The end time of the observed session.
+          "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the session relative to the Coordinated Universal Time (UTC).
+          "startTime": "A String", # Required. The start time of the observed session.
+          "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the session relative to the Coordinated Universal Time (UTC).
+        },
+      },
+      "name": "A String", # Identifier. Data point name, only supported for the subset of identifiable data types. For the majority of the data types, individual data points do not need to be identified and this field would be empty. Format: `users/{user}/dataTypes/{data_type}/dataPoints/{data_point}` Example: `users/abcd1234/dataTypes/sleep/dataPoints/a1b2c3d4-e5f6-7890-1234-567890abcdef` The `{user}` ID is a system-generated identifier, as described in Identity.health_user_id. The `{data_type}` ID corresponds to the kebab-case version of the field names in the DataPoint data union field, e.g. `total-calories` for the `total_calories` field. The `{data_point}` ID can be client-provided or system-generated. If client-provided, it must be a string of 4-63 characters, containing only lowercase letters, numbers, and hyphens.
+      "oxygenSaturation": { # Captures the user's instantaneous oxygen saturation percentage (SpO2). # Optional. Data for points in the `oxygen-saturation` sample data type collection.
+        "percentage": 3.14, # Required. The oxygen saturation percentage. Valid values are from 0 to 100.
+        "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which oxygen saturation was measured.
+          "civilTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. The civil time in the timezone the subject is in at the time of the observation.
+            "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+              "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+              "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+              "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+            },
+            "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+              "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+              "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+              "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+          },
+          "physicalTime": "A String", # Required. The time of the observation.
+          "utcOffset": "A String", # Required. The offset of the user's local time during the observation relative to the Coordinated Universal Time (UTC).
+        },
+      },
+      "respiratoryRateSleepSummary": { # Records respiratory rate details during sleep. Can have multiple per day if the user sleeps multiple times. # Optional. Data for points in the `respiratory-rate-sleep-summary` sample data type collection.
+        "deepSleepStats": { # Respiratory rate statistics for a given sleep stage. # Optional. Respiratory rate statistics for deep sleep.
+          "breathsPerMinute": 3.14, # Required. Average breaths per minute.
+          "signalToNoise": 3.14, # Optional. How trustworthy the data is for the computation.
+          "standardDeviation": 3.14, # Optional. Standard deviation of the respiratory rate during sleep.
+        },
+        "fullSleepStats": { # Respiratory rate statistics for a given sleep stage. # Required. Full respiratory rate statistics.
+          "breathsPerMinute": 3.14, # Required. Average breaths per minute.
+          "signalToNoise": 3.14, # Optional. How trustworthy the data is for the computation.
+          "standardDeviation": 3.14, # Optional. Standard deviation of the respiratory rate during sleep.
+        },
+        "lightSleepStats": { # Respiratory rate statistics for a given sleep stage. # Optional. Respiratory rate statistics for light sleep.
+          "breathsPerMinute": 3.14, # Required. Average breaths per minute.
+          "signalToNoise": 3.14, # Optional. How trustworthy the data is for the computation.
+          "standardDeviation": 3.14, # Optional. Standard deviation of the respiratory rate during sleep.
+        },
+        "remSleepStats": { # Respiratory rate statistics for a given sleep stage. # Optional. Respiratory rate statistics for REM sleep.
+          "breathsPerMinute": 3.14, # Required. Average breaths per minute.
+          "signalToNoise": 3.14, # Optional. How trustworthy the data is for the computation.
+          "standardDeviation": 3.14, # Optional. Standard deviation of the respiratory rate during sleep.
+        },
+        "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which respiratory rate was measured.
+          "civilTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. The civil time in the timezone the subject is in at the time of the observation.
+            "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+              "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+              "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+              "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+            },
+            "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+              "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+              "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+              "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+          },
+          "physicalTime": "A String", # Required. The time of the observation.
+          "utcOffset": "A String", # Required. The offset of the user's local time during the observation relative to the Coordinated Universal Time (UTC).
+        },
+      },
+      "runVo2Max": { # VO2 max value calculated based on the user's running activity. Value stored in ml/kg/min. # Optional. Data for points in the `run-vo2-max` sample data type collection.
+        "runVo2Max": 3.14, # Required. Run VO2 max value in ml/kg/min.
+        "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which the metric was measured.
+          "civilTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. The civil time in the timezone the subject is in at the time of the observation.
+            "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+              "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+              "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+              "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+            },
+            "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+              "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+              "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+              "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+          },
+          "physicalTime": "A String", # Required. The time of the observation.
+          "utcOffset": "A String", # Required. The offset of the user's local time during the observation relative to the Coordinated Universal Time (UTC).
+        },
+      },
+      "sedentaryPeriod": { # SedentaryPeriod SedentaryPeriod data represents the periods of time that the user was sedentary (i.e. not moving while wearing the device). # Optional. Data for points in the `sedentary-period` interval data type collection.
+        "interval": { # Represents a time interval of an observed data point. # Required. Observed interval.
+          "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval end time in civil time in the timezone the subject is in at the end of the observed interval
+            "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+              "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+              "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+              "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+            },
+            "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+              "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+              "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+              "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+          },
+          "civilStartTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval start time in civil time in the timezone the subject is in at the start of the observed interval
+            "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+              "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+              "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+              "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+            },
+            "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+              "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+              "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+              "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+          },
+          "endTime": "A String", # Required. Observed interval end time.
+          "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the observation relative to the Coordinated Universal Time (UTC).
+          "startTime": "A String", # Required. Observed interval start time.
+          "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the observation relative to the Coordinated Universal Time (UTC).
+        },
+      },
+      "sleep": { # A sleep session possibly including stages. # Optional. Data for points in the `sleep` session data type collection.
+        "createTime": "A String", # Output only. Creation time of this sleep observation.
+        "interval": { # Represents a time interval of session data point, which bundles multiple observed metrics together. # Required. Observed sleep interval.
+          "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Session end time in civil time in the timezone the subject is in at the end of the session.
+            "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+              "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+              "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+              "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+            },
+            "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+              "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+              "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+              "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+          },
+          "civilStartTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Session start time in civil time in the timezone the subject is in at the start of the session.
+            "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+              "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+              "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+              "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+            },
+            "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+              "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+              "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+              "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+          },
+          "endTime": "A String", # Required. The end time of the observed session.
+          "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the session relative to the Coordinated Universal Time (UTC).
+          "startTime": "A String", # Required. The start time of the observed session.
+          "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the session relative to the Coordinated Universal Time (UTC).
+        },
+        "metadata": { # Additional information about how the sleep was processed. # Optional. Sleep metadata: processing, main, manually edited, stages status.
+          "externalId": "A String", # Optional. Sleep identifier relevant in the context of the data source.
+          "manuallyEdited": True or False, # Output only. Some sleeps autodetected by algorithms can be manually edited by users.
+          "nap": True or False, # Output only. Naps are sleeps without stages and relatively short durations.
+          "processed": True or False, # Output only. Sleep and sleep stages algorithms finished processing.
+          "stagesStatus": "A String", # Output only. Sleep stages algorithm processing status.
+        },
+        "outOfBedSegments": [ # Optional. “Out of bed” segments that can overlap with sleep stages.
+          { # A time interval to represent an out-of-bed segment.
+            "endTime": "A String", # Required. Segment end time.
+            "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the segment relative to the Coordinated Universal Time (UTC).
+            "startTime": "A String", # Required. Segment tart time.
+            "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the segment relative to the Coordinated Universal Time (UTC).
+          },
+        ],
+        "stages": [ # Optional. List of non-overlapping contiguous sleep stage segments that cover the sleep period.
+          { # Sleep stage segment.
+            "createTime": "A String", # Output only. Creation time of this sleep stages segment.
+            "endTime": "A String", # Required. Sleep stage end time.
+            "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the sleep stage relative to the Coordinated Universal Time (UTC).
+            "startTime": "A String", # Required. Sleep stage start time.
+            "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the sleep stage relative to the Coordinated Universal Time (UTC).
+            "type": "A String", # Required. Sleep stage type: AWAKE, DEEP, REM, LIGHT etc.
+            "updateTime": "A String", # Output only. Last update time of this sleep stages segment.
+          },
+        ],
+        "summary": { #  Sleep summary: metrics and stages summary. # Output only. Sleep summary: metrics and stages summary.
+          "minutesAfterWakeUp": "A String", # Output only. Minutes after wake up calculated by restlessness algorithm.
+          "minutesAsleep": "A String", # Output only. Total number of minutes asleep. For classic sleep it is the sum of ASLEEP stages (excluding AWAKE and RESTLESS). For "stages" sleep it is the sum of LIGHT, REM and DEEP stages (excluding AWAKE).
+          "minutesAwake": "A String", # Output only. Total number of minutes awake. It is a sum of all AWAKE stages.
+          "minutesInSleepPeriod": "A String", # Output only. Delta between wake time and bedtime. It is the sum of all stages.
+          "minutesToFallAsleep": "A String", # Output only. Minutes to fall asleep calculated by restlessness algorithm.
+          "stagesSummary": [ # Output only. List of summaries (total duration and segment count) per each sleep stage type.
+            { # Total duration and segment count for a stage.
+              "count": "A String", # Output only. Number of sleep stages segments.
+              "minutes": "A String", # Output only. Total duration in minutes of a sleep stage.
+              "type": "A String", # Output only. Sleep stage type: AWAKE, DEEP, REM, LIGHT etc.
+            },
+          ],
+        },
+        "type": "A String", # Optional. SleepType: classic or stages.
+        "updateTime": "A String", # Output only. Last update time of this sleep observation.
+      },
+      "steps": { # Step count over the time interval. # Optional. Data for points in the `steps` interval data type collection.
+        "count": "A String", # Required. Number of steps in the recorded interval.
+        "interval": { # Represents a time interval of an observed data point. # Required. Observed interval.
+          "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval end time in civil time in the timezone the subject is in at the end of the observed interval
+            "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+              "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+              "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+              "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+            },
+            "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+              "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+              "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+              "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+          },
+          "civilStartTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval start time in civil time in the timezone the subject is in at the start of the observed interval
+            "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+              "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+              "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+              "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+            },
+            "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+              "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+              "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+              "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+          },
+          "endTime": "A String", # Required. Observed interval end time.
+          "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the observation relative to the Coordinated Universal Time (UTC).
+          "startTime": "A String", # Required. Observed interval start time.
+          "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the observation relative to the Coordinated Universal Time (UTC).
+        },
+      },
+      "timeInHeartRateZone": { # Time in heart rate zone record. It's an interval spent in specific heart rate zone. # Optional. Data for points in the `time-in-heart-rate-zone` interval data type collection.
+        "heartRateZoneType": "A String", # Required. Heart rate zone type.
+        "interval": { # Represents a time interval of an observed data point. # Required. Observed interval.
+          "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval end time in civil time in the timezone the subject is in at the end of the observed interval
+            "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+              "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+              "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+              "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+            },
+            "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+              "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+              "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+              "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+          },
+          "civilStartTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval start time in civil time in the timezone the subject is in at the start of the observed interval
+            "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+              "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+              "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+              "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+            },
+            "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+              "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+              "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+              "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+          },
+          "endTime": "A String", # Required. Observed interval end time.
+          "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the observation relative to the Coordinated Universal Time (UTC).
+          "startTime": "A String", # Required. Observed interval start time.
+          "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the observation relative to the Coordinated Universal Time (UTC).
+        },
+      },
+      "vo2Max": { # VO2 max measurement. # Optional. Data for points in the `vo2-max` sample data type collection.
+        "measurementMethod": "A String", # Optional. The method used to measure the VO2 max value.
+        "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which VO2 max was measured.
+          "civilTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. The civil time in the timezone the subject is in at the time of the observation.
+            "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+              "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+              "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+              "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+            },
+            "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+              "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+              "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+              "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+          },
+          "physicalTime": "A String", # Required. The time of the observation.
+          "utcOffset": "A String", # Required. The offset of the user's local time during the observation relative to the Coordinated Universal Time (UTC).
+        },
+        "vo2Max": 3.14, # Required. VO2 max value measured as in ml consumed oxygen / kg of body weight / min.
+      },
+      "weight": { # Body weight measurement. # Optional. Data for points in the `weight` sample data type collection.
+        "notes": "A String", # Optional. Standard free-form notes captured at manual logging.
+        "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which the weight was measured
+          "civilTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. The civil time in the timezone the subject is in at the time of the observation.
+            "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+              "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+              "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+              "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+            },
+            "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+              "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+              "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+              "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+          },
+          "physicalTime": "A String", # Required. The time of the observation.
+          "utcOffset": "A String", # Required. The offset of the user's local time during the observation relative to the Coordinated Universal Time (UTC).
+        },
+        "weightGrams": 3.14, # Required. Weight of a user in grams.
+      },
+    },
+  ],
+  "nextPageToken": "A String", # Next page token, empty if the response is complete
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(name, body=None, x__xgafv=None) +
Updates a single identifiable data point. If a data point with the specified `name` is not found, the request will fail.
+
+Args:
+  name: string, Identifier. Data point name, only supported for the subset of identifiable data types. For the majority of the data types, individual data points do not need to be identified and this field would be empty. Format: `users/{user}/dataTypes/{data_type}/dataPoints/{data_point}` Example: `users/abcd1234/dataTypes/sleep/dataPoints/a1b2c3d4-e5f6-7890-1234-567890abcdef` The `{user}` ID is a system-generated identifier, as described in Identity.health_user_id. The `{data_type}` ID corresponds to the kebab-case version of the field names in the DataPoint data union field, e.g. `total-calories` for the `total_calories` field. The `{data_point}` ID can be client-provided or system-generated. If client-provided, it must be a string of 4-63 characters, containing only lowercase letters, numbers, and hyphens. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A computed or recorded metric.
+  "activeMinutes": { # Record of active minutes in a given time interval. # Optional. Data for points in the `active-minutes` interval data type collection.
+    "activeMinutesByActivityLevel": [ # Required. Active minutes by activity level. At most one record per activity level is allowed.
+      { # Active minutes at a given activity level.
+        "activeMinutes": "A String", # Required. Number of whole minutes spent in activity.
+        "activityLevel": "A String", # Required. The level of activity.
+      },
+    ],
+    "interval": { # Represents a time interval of an observed data point. # Required. Observed interval.
+      "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval end time in civil time in the timezone the subject is in at the end of the observed interval
+        "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+          "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+          "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+          "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+        },
+        "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+          "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+          "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+          "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+          "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+        },
+      },
+      "civilStartTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval start time in civil time in the timezone the subject is in at the start of the observed interval
+        "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+          "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+          "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+          "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+        },
+        "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+          "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+          "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+          "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+          "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+        },
+      },
+      "endTime": "A String", # Required. Observed interval end time.
+      "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the observation relative to the Coordinated Universal Time (UTC).
+      "startTime": "A String", # Required. Observed interval start time.
+      "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the observation relative to the Coordinated Universal Time (UTC).
+    },
+  },
+  "activeZoneMinutes": { # Record of active zone minutes in a given time interval. # Optional. Data for points in the `active-zone-minutes` interval data type collection, measured in minutes.
+    "activeZoneMinutes": "A String", # Required. Number of Active Zone Minutes earned in the given time interval. Note: active_zone_minutes equals to 1 for low intensity (fat burn) zones or 2 for high intensity zones (cardio, peak).
+    "heartRateZone": "A String", # Required. Heart rate zone in which the active zone minutes have been earned, in the given time interval.
+    "interval": { # Represents a time interval of an observed data point. # Required. Observed interval.
+      "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval end time in civil time in the timezone the subject is in at the end of the observed interval
+        "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+          "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+          "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+          "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+        },
+        "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+          "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+          "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+          "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+          "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+        },
+      },
+      "civilStartTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval start time in civil time in the timezone the subject is in at the start of the observed interval
+        "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+          "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+          "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+          "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+        },
+        "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+          "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+          "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+          "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+          "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+        },
+      },
+      "endTime": "A String", # Required. Observed interval end time.
+      "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the observation relative to the Coordinated Universal Time (UTC).
+      "startTime": "A String", # Required. Observed interval start time.
+      "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the observation relative to the Coordinated Universal Time (UTC).
+    },
+  },
+  "activityLevel": { # Internal type to capture activity level during a certain time interval. # Optional. Data for points in the `activity-level` daily data type collection.
+    "activityLevelType": "A String", # Required. Activity level type in the given time interval.
+    "interval": { # Represents a time interval of an observed data point. # Required. Observed interval.
+      "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval end time in civil time in the timezone the subject is in at the end of the observed interval
+        "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+          "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+          "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+          "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+        },
+        "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+          "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+          "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+          "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+          "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+        },
+      },
+      "civilStartTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval start time in civil time in the timezone the subject is in at the start of the observed interval
+        "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+          "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+          "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+          "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+        },
+        "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+          "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+          "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+          "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+          "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+        },
+      },
+      "endTime": "A String", # Required. Observed interval end time.
+      "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the observation relative to the Coordinated Universal Time (UTC).
+      "startTime": "A String", # Required. Observed interval start time.
+      "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the observation relative to the Coordinated Universal Time (UTC).
+    },
+  },
+  "altitude": { # Captures the altitude gain (i.e. deltas), and not level above sea, for a user in millimeters. # Optional. Data for points in the `altitude` interval data type collection.
+    "gainMillimeters": "A String", # Required. Altitude gain in millimeters over the observed interval.
+    "interval": { # Represents a time interval of an observed data point. # Required. Observed interval.
+      "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval end time in civil time in the timezone the subject is in at the end of the observed interval
+        "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+          "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+          "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+          "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+        },
+        "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+          "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+          "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+          "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+          "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+        },
+      },
+      "civilStartTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval start time in civil time in the timezone the subject is in at the start of the observed interval
+        "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+          "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+          "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+          "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+        },
+        "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+          "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+          "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+          "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+          "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+        },
+      },
+      "endTime": "A String", # Required. Observed interval end time.
+      "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the observation relative to the Coordinated Universal Time (UTC).
+      "startTime": "A String", # Required. Observed interval start time.
+      "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the observation relative to the Coordinated Universal Time (UTC).
+    },
+  },
+  "bodyFat": { # Body fat measurement. # Optional. Data for points in the `body-fat` sample data type collection.
+    "percentage": 3.14, # Required. Body fat percentage, in range [0, 100].
+    "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which body fat was measured.
+      "civilTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. The civil time in the timezone the subject is in at the time of the observation.
+        "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+          "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+          "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+          "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+        },
+        "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+          "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+          "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+          "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+          "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+        },
+      },
+      "physicalTime": "A String", # Required. The time of the observation.
+      "utcOffset": "A String", # Required. The offset of the user's local time during the observation relative to the Coordinated Universal Time (UTC).
+    },
+  },
+  "dailyHeartRateVariability": { # Represents the daily heart rate variability data type. At least one of the following fields must be set: - `average_heart_rate_variability_milliseconds` - `non_rem_heart_rate_beats_per_minute` - `entropy` - `deep_sleep_root_mean_square_of_successive_differences_milliseconds` # Optional. Data for points in the `daily-heart-rate-variability` daily data type collection.
+    "averageHeartRateVariabilityMilliseconds": 3.14, # Optional. A user's average heart rate variability calculated using the root mean square of successive differences (RMSSD) in times between heartbeats.
+    "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Date (in the user's timezone) of heart rate variability measurement.
+      "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+      "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+      "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+    },
+    "deepSleepRootMeanSquareOfSuccessiveDifferencesMilliseconds": 3.14, # Optional. The root mean square of successive differences (RMSSD) value during deep sleep.
+    "entropy": 3.14, # Optional. The Shanon entropy of heartbeat intervals. Entropy quantifies randomness or disorder in a system. High entropy indicates high HRV. Entropy is measured from the histogram of time interval between successive heart beats values measured during sleep.
+    "nonRemHeartRateBeatsPerMinute": "A String", # Optional. Non-REM heart rate
+  },
+  "dailyHeartRateZones": { # User's heart rate zone thresholds based on the Karvonen algorithm for a specific day. # Optional. Data for points in the `daily-heart-rate-zones` daily data type collection.
+    "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Date (in user's timezone) of the heart rate zones record.
+      "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+      "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+      "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+    },
+    "heartRateZones": [ # Required. The heart rate zones.
+      { # The heart rate zone.
+        "heartRateZoneType": "A String", # Required. The heart rate zone type.
+        "maxBeatsPerMinute": "A String", # Required. Maximum heart rate for this zone in beats per minute.
+        "minBeatsPerMinute": "A String", # Required. Minimum heart rate for this zone in beats per minute.
+      },
+    ],
+  },
+  "dailyOxygenSaturation": { # A daily oxygen saturation (SpO2) record. Represents the user's daily oxygen saturation summary, typically calculated during sleep. # Optional. Data for points in the `daily-oxygen-saturation` daily data type collection.
+    "averagePercentage": 3.14, # Required. The average value of the oxygen saturation samples during the sleep.
+    "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Date (in user's timezone) of the daily oxygen saturation record.
+      "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+      "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+      "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+    },
+    "lowerBoundPercentage": 3.14, # Required. The lower bound of the confidence interval of oxygen saturation samples during sleep.
+    "standardDeviationPercentage": 3.14, # Optional. Standard deviation of the daily oxygen saturation averages from the past 7-30 days.
+    "upperBoundPercentage": 3.14, # Required. The upper bound of the confidence interval of oxygen saturation samples during sleep.
+  },
+  "dailyRespiratoryRate": { # A daily average respiratory rate (breaths per minute) for a day of the year. One data point per day calculated for the main sleep. # Optional. Data for points in the `daily-respiratory-rate` daily data type collection.
+    "breathsPerMinute": 3.14, # Required. The average number of breaths taken per minute.
+    "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. The date on which the respiratory rate was measured.
+      "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+      "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+      "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+    },
+  },
+  "dailyRestingHeartRate": { # Measures the daily resting heart rate for a user, calculated using the all day heart rate measurements. # Optional. Data for points in the `daily-resting-heart-rate` daily data type collection.
+    "beatsPerMinute": "A String", # Required. The resting heart rate value in beats per minute.
+    "dailyRestingHeartRateMetadata": { # Metadata for the daily resting heart rate. # Optional. Metadata for the daily resting heart rate.
+      "calculationMethod": "A String", # Required. The method used to calculate the resting heart rate.
+    },
+    "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Date (in the user's timezone) of the resting heart rate measurement.
+      "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+      "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+      "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+    },
+  },
+  "dailySleepTemperatureDerivations": { # Provides derived sleep temperature values, calculated from skin or internal device temperature readings during sleep. # Optional. Data for points in the `daily-sleep-temperature-derivations` daily data type collection.
+    "baselineTemperatureCelsius": 3.14, # Optional. The user's baseline skin temperature. It is the median of the user's nightly skin temperature over the past 30 days.
+    "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Date for which the sleep temperature derivations are calculated.
+      "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+      "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+      "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+    },
+    "nightlyTemperatureCelsius": 3.14, # Required. The user's nightly skin temperature. It is the mean of skin temperature samples taken from the user’s sleep.
+    "relativeNightlyStddev30dCelsius": 3.14, # Optional. The standard deviation of the user’s relative nightly skin temperature (temperature - baseline) over the past 30 days.
+  },
+  "dailyVo2Max": { # Contains a daily summary of the user's VO2 max (cardio fitness score), which is the maximum rate of oxygen the body can use during exercise. # Optional. Data for points in the `daily-vo2-max` daily data type collection.
+    "cardioFitnessLevel": "A String", # Optional. Represents the user's cardio fitness level based on their VO2 max.
+    "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. The date for which the Daily VO2 max was measured.
+      "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+      "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+      "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+    },
+    "estimated": True or False, # Optional. An estimated field is added to indicate when the confidence has decreased sufficiently to consider the value an estimation.
+    "vo2Max": 3.14, # Required. Daily VO2 max value measured as in ml consumed oxygen / kg of body weight / min.
+    "vo2MaxCovariance": 3.14, # Optional. The covariance of the VO2 max value.
+  },
+  "dataSource": { # Data Source definition to track the origin of data. Each health data point, regardless of the complexity or data model (whether a simple step count or a detailed sleep session) must retain information about its source of origin (e.g. the device or app that collected it). # Optional. Data source information for the metric
+    "application": { # Optional metadata for the application that provided this data. # Output only. Captures metadata for the application that provided this data.
+      "googleWebClientId": "A String", # Output only. The Google OAuth 2.0 client ID of the web application or service that recorded the data. This is the client ID used during the Google OAuth flow to obtain user credentials. This field is system-populated when the data is uploaded from Google Web API.
+      "packageName": "A String", # Output only. A unique identifier for the mobile application that was the source of the data. This is typically the application's package name on Android (e.g., `com.google.fitbit`) or the bundle ID on iOS. This field is informational and helps trace data origin. This field is system-populated when the data is uploaded from the Fitbit mobile application, Health Connect or Health Kit.
+      "webClientId": "A String", # Output only. The client ID of the application that recorded the data. This ID is a legacy Fitbit API client ID, which is different from a Google OAuth client ID. Example format: `ABC123`. This field is system-populated and used for tracing data from legacy Fitbit API integrations. This field is system-populated when the data is uploaded from a legacy Fitbit API integration.
+    },
+    "device": { # Captures metadata about the device that recorded the measurement. # Optional. Captures metadata for raw data points originating from devices. We expect this data source to be used for data points written on device sync.
+      "displayName": "A String", # Optional. An optional name for the device.
+      "formFactor": "A String", # Optional. Captures the form factor of the device.
+      "manufacturer": "A String", # Optional. An optional manufacturer of the device.
+    },
+    "platform": "A String", # Output only. Captures the platform that uploaded the data.
+    "recordingMethod": "A String", # Optional. Captures how the data was recorded.
+  },
+  "distance": { # Distance traveled over an interval of time. # Optional. Data for points in the `distance` interval data type collection.
+    "interval": { # Represents a time interval of an observed data point. # Required. Observed interval.
+      "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval end time in civil time in the timezone the subject is in at the end of the observed interval
+        "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+          "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+          "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+          "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+        },
+        "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+          "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+          "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+          "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+          "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+        },
+      },
+      "civilStartTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval start time in civil time in the timezone the subject is in at the start of the observed interval
+        "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+          "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+          "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+          "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+        },
+        "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+          "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+          "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+          "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+          "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+        },
+      },
+      "endTime": "A String", # Required. Observed interval end time.
+      "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the observation relative to the Coordinated Universal Time (UTC).
+      "startTime": "A String", # Required. Observed interval start time.
+      "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the observation relative to the Coordinated Universal Time (UTC).
+    },
+    "millimeters": "A String", # Required. Distance in millimeters over the observed interval.
+  },
+  "exercise": { # An exercise that stores information about a physical activity. # Optional. Data for points in the `exercise` session data type collection.
+    "activeDuration": "A String", # Optional. Duration excluding pauses.
+    "createTime": "A String", # Output only. Represents the timestamp of the creation of the exercise.
+    "displayName": "A String", # Required. Exercise display name.
+    "exerciseEvents": [ # Optional. Exercise events that happen during an exercise, such as pause & restarts.
+      { # Represents instantaneous events that happen during an exercise, such as start, stop, pause, split.
+        "eventTime": "A String", # Required. Exercise event time
+        "eventUtcOffset": "A String", # Required. Exercise event time offset from UTC
+        "exerciseEventType": "A String", # Required. The type of the event, such as start, stop, pause, resume.
+      },
+    ],
+    "exerciseMetadata": { # Additional exercise metadata. # Optional. Additional exercise metadata.
+      "hasGps": True or False, # Optional. Whether the exercise had GPS tracking.
+      "poolLengthMillimeters": "A String", # Optional. Pool length in millimeters. Only present in the swimming exercises.
+    },
+    "exerciseType": "A String", # Required. The type of activity performed during an exercise.
+    "interval": { # Represents a time interval of session data point, which bundles multiple observed metrics together. # Required. Observed exercise interval
+      "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Session end time in civil time in the timezone the subject is in at the end of the session.
+        "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+          "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+          "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+          "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+        },
+        "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+          "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+          "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+          "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+          "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+        },
+      },
+      "civilStartTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Session start time in civil time in the timezone the subject is in at the start of the session.
+        "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+          "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+          "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+          "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+        },
+        "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+          "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+          "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+          "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+          "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+        },
+      },
+      "endTime": "A String", # Required. The end time of the observed session.
+      "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the session relative to the Coordinated Universal Time (UTC).
+      "startTime": "A String", # Required. The start time of the observed session.
+      "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the session relative to the Coordinated Universal Time (UTC).
+    },
+    "metricsSummary": { # Summary metrics for an exercise. # Required. Summary metrics for this exercise ( )
+      "activeZoneMinutes": "A String", # Optional. Total active zone minutes for the exercise.
+      "averageHeartRateBeatsPerMinute": "A String", # Optional. Average heart rate during the exercise.
+      "averagePaceSecondsPerMeter": 3.14, # Optional. Average pace in seconds per meter.
+      "averageSpeedMillimetersPerSecond": 3.14, # Optional. Average speed in millimeters per second.
+      "caloriesKcal": 3.14, # Optional. Total calories burned by the user during the exercise.
+      "distanceMillimeters": 3.14, # Optional. Total distance covered by the user during the exercise.
+      "elevationGainMillimeters": 3.14, # Optional. Total elevation gain during the exercise.
+      "heartRateZoneDurations": { # Time spent in each heart rate zone. # Optional. Time spent in each heart rate zone.
+        "lightTime": "A String", # Optional. Time spent in light heart rate zone.
+        "moderateTime": "A String", # Optional. Time spent in moderate heart rate zone.
+        "peakTime": "A String", # Optional. Time spent in peak heart rate zone.
+        "vigorousTime": "A String", # Optional. Time spent in vigorous heart rate zone.
+      },
+      "mobilityMetrics": { # Mobility workouts specific metrics # Optional. Mobility workouts specific metrics. Only present in the advanced running exercises.
+        "avgCadenceStepsPerMinute": 3.14, # Optional. Cadence is a measure of the frequency of your foot strikes. Steps / min in real time during workout.
+        "avgGroundContactTimeDuration": "A String", # Optional. The ground contact time for a particular stride is the amount of time for which the foot was in contact with the ground on that stride
+        "avgStrideLengthMillimeters": "A String", # Optional. Stride length is a measure of the distance covered by a single stride
+        "avgVerticalOscillationMillimeters": "A String", # Optional. Distance off the ground your center of mass moves with each stride while running
+        "avgVerticalRatio": 3.14, # Optional. Vertical oscillation/stride length between [5.0, 11.0].
+      },
+      "runVo2Max": 3.14, # Optional. Run VO2 max value for the exercise. Only present in the running exercises at the top level as in the summary of the whole exercise.
+      "steps": "A String", # Optional. Total steps taken during the exercise.
+      "totalSwimLengths": 3.14, # Optional. Number of full pool lengths completed during the exercise. Only present in the swimming exercises at the top level as in the summary of the whole exercise.
+    },
+    "notes": "A String", # Optional. Standard free-form notes captured at manual logging.
+    "splitSummaries": [ # Optional. Laps or splits recorded within an exercise. Laps could be split based on distance or other criteria (duration, etc.) Laps should not be overlapping with each other.
+      { # Represents splits or laps recorded within an exercise. Lap events partition a workout into segments based on criteria like distance, time, or calories.
+        "activeDuration": "A String", # Output only. Lap time excluding the pauses.
+        "endTime": "A String", # Required. Lap end time
+        "endUtcOffset": "A String", # Required. Lap end time offset from UTC
+        "metricsSummary": { # Summary metrics for an exercise. # Required. Summary metrics for this split.
+          "activeZoneMinutes": "A String", # Optional. Total active zone minutes for the exercise.
+          "averageHeartRateBeatsPerMinute": "A String", # Optional. Average heart rate during the exercise.
+          "averagePaceSecondsPerMeter": 3.14, # Optional. Average pace in seconds per meter.
+          "averageSpeedMillimetersPerSecond": 3.14, # Optional. Average speed in millimeters per second.
+          "caloriesKcal": 3.14, # Optional. Total calories burned by the user during the exercise.
+          "distanceMillimeters": 3.14, # Optional. Total distance covered by the user during the exercise.
+          "elevationGainMillimeters": 3.14, # Optional. Total elevation gain during the exercise.
+          "heartRateZoneDurations": { # Time spent in each heart rate zone. # Optional. Time spent in each heart rate zone.
+            "lightTime": "A String", # Optional. Time spent in light heart rate zone.
+            "moderateTime": "A String", # Optional. Time spent in moderate heart rate zone.
+            "peakTime": "A String", # Optional. Time spent in peak heart rate zone.
+            "vigorousTime": "A String", # Optional. Time spent in vigorous heart rate zone.
+          },
+          "mobilityMetrics": { # Mobility workouts specific metrics # Optional. Mobility workouts specific metrics. Only present in the advanced running exercises.
+            "avgCadenceStepsPerMinute": 3.14, # Optional. Cadence is a measure of the frequency of your foot strikes. Steps / min in real time during workout.
+            "avgGroundContactTimeDuration": "A String", # Optional. The ground contact time for a particular stride is the amount of time for which the foot was in contact with the ground on that stride
+            "avgStrideLengthMillimeters": "A String", # Optional. Stride length is a measure of the distance covered by a single stride
+            "avgVerticalOscillationMillimeters": "A String", # Optional. Distance off the ground your center of mass moves with each stride while running
+            "avgVerticalRatio": 3.14, # Optional. Vertical oscillation/stride length between [5.0, 11.0].
+          },
+          "runVo2Max": 3.14, # Optional. Run VO2 max value for the exercise. Only present in the running exercises at the top level as in the summary of the whole exercise.
+          "steps": "A String", # Optional. Total steps taken during the exercise.
+          "totalSwimLengths": 3.14, # Optional. Number of full pool lengths completed during the exercise. Only present in the swimming exercises at the top level as in the summary of the whole exercise.
+        },
+        "splitType": "A String", # Required. Method used to split the exercise laps. Users may manually mark the lap as complete even if the tracking is automatic.
+        "startTime": "A String", # Required. Lap start time
+        "startUtcOffset": "A String", # Required. Lap start time offset from UTC
+      },
+    ],
+    "splits": [ # Optional. The default split is 1 km or 1 mile. - if the movement distance is less than the default, then there are no splits - if the movement distance is greater than or equal to the default, then we have splits
+      { # Represents splits or laps recorded within an exercise. Lap events partition a workout into segments based on criteria like distance, time, or calories.
+        "activeDuration": "A String", # Output only. Lap time excluding the pauses.
+        "endTime": "A String", # Required. Lap end time
+        "endUtcOffset": "A String", # Required. Lap end time offset from UTC
+        "metricsSummary": { # Summary metrics for an exercise. # Required. Summary metrics for this split.
+          "activeZoneMinutes": "A String", # Optional. Total active zone minutes for the exercise.
+          "averageHeartRateBeatsPerMinute": "A String", # Optional. Average heart rate during the exercise.
+          "averagePaceSecondsPerMeter": 3.14, # Optional. Average pace in seconds per meter.
+          "averageSpeedMillimetersPerSecond": 3.14, # Optional. Average speed in millimeters per second.
+          "caloriesKcal": 3.14, # Optional. Total calories burned by the user during the exercise.
+          "distanceMillimeters": 3.14, # Optional. Total distance covered by the user during the exercise.
+          "elevationGainMillimeters": 3.14, # Optional. Total elevation gain during the exercise.
+          "heartRateZoneDurations": { # Time spent in each heart rate zone. # Optional. Time spent in each heart rate zone.
+            "lightTime": "A String", # Optional. Time spent in light heart rate zone.
+            "moderateTime": "A String", # Optional. Time spent in moderate heart rate zone.
+            "peakTime": "A String", # Optional. Time spent in peak heart rate zone.
+            "vigorousTime": "A String", # Optional. Time spent in vigorous heart rate zone.
+          },
+          "mobilityMetrics": { # Mobility workouts specific metrics # Optional. Mobility workouts specific metrics. Only present in the advanced running exercises.
+            "avgCadenceStepsPerMinute": 3.14, # Optional. Cadence is a measure of the frequency of your foot strikes. Steps / min in real time during workout.
+            "avgGroundContactTimeDuration": "A String", # Optional. The ground contact time for a particular stride is the amount of time for which the foot was in contact with the ground on that stride
+            "avgStrideLengthMillimeters": "A String", # Optional. Stride length is a measure of the distance covered by a single stride
+            "avgVerticalOscillationMillimeters": "A String", # Optional. Distance off the ground your center of mass moves with each stride while running
+            "avgVerticalRatio": 3.14, # Optional. Vertical oscillation/stride length between [5.0, 11.0].
+          },
+          "runVo2Max": 3.14, # Optional. Run VO2 max value for the exercise. Only present in the running exercises at the top level as in the summary of the whole exercise.
+          "steps": "A String", # Optional. Total steps taken during the exercise.
+          "totalSwimLengths": 3.14, # Optional. Number of full pool lengths completed during the exercise. Only present in the swimming exercises at the top level as in the summary of the whole exercise.
+        },
+        "splitType": "A String", # Required. Method used to split the exercise laps. Users may manually mark the lap as complete even if the tracking is automatic.
+        "startTime": "A String", # Required. Lap start time
+        "startUtcOffset": "A String", # Required. Lap start time offset from UTC
+      },
+    ],
+    "updateTime": "A String", # Output only. This is the timestamp of the last update to the exercise.
+  },
+  "floors": { # Gained elevation measured in floors over the time interval # Optional. Data for points in the `floors` interval data type collection.
+    "count": "A String", # Required. Number of floors in the recorded interval
+    "interval": { # Represents a time interval of an observed data point. # Required. Observed interval
+      "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval end time in civil time in the timezone the subject is in at the end of the observed interval
+        "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+          "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+          "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+          "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+        },
+        "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+          "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+          "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+          "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+          "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+        },
+      },
+      "civilStartTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval start time in civil time in the timezone the subject is in at the start of the observed interval
+        "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+          "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+          "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+          "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+        },
+        "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+          "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+          "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+          "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+          "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+        },
+      },
+      "endTime": "A String", # Required. Observed interval end time.
+      "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the observation relative to the Coordinated Universal Time (UTC).
+      "startTime": "A String", # Required. Observed interval start time.
+      "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the observation relative to the Coordinated Universal Time (UTC).
+    },
+  },
+  "heartRate": { # A heart rate measurement. # Optional. Data for points in the `heart-rate` sample data type collection.
+    "beatsPerMinute": "A String", # Required. The heart rate value in beats per minute.
+    "metadata": { # Heart rate metadata. # Optional. Metadata about the heart rate sample.
+      "motionContext": "A String", # Optional. Indicates the user’s level of activity when the heart rate sample was measured
+      "sensorLocation": "A String", # Optional. Indicates the location of the sensor that measured the heart rate.
+    },
+    "sampleTime": { # Represents a sample time of an observed data point. # Required. Observation time
+      "civilTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. The civil time in the timezone the subject is in at the time of the observation.
+        "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+          "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+          "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+          "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+        },
+        "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+          "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+          "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+          "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+          "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+        },
+      },
+      "physicalTime": "A String", # Required. The time of the observation.
+      "utcOffset": "A String", # Required. The offset of the user's local time during the observation relative to the Coordinated Universal Time (UTC).
+    },
+  },
+  "heartRateVariability": { # Captures user's heart rate variability (HRV) as measured by the root mean square of successive differences (RMSSD) between normal heartbeats or by standard deviation of the inter-beat intervals (SDNN). # Optional. Data for points in the `heart-rate-variability` sample data type collection.
+    "rootMeanSquareOfSuccessiveDifferencesMilliseconds": 3.14, # Optional. The root mean square of successive differences between normal heartbeats. This is a measure of heart rate variability used by Fitbit.
+    "sampleTime": { # Represents a sample time of an observed data point. # Required. The time of the heart rate variability measurement.
+      "civilTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. The civil time in the timezone the subject is in at the time of the observation.
+        "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+          "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+          "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+          "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+        },
+        "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+          "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+          "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+          "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+          "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+        },
+      },
+      "physicalTime": "A String", # Required. The time of the observation.
+      "utcOffset": "A String", # Required. The offset of the user's local time during the observation relative to the Coordinated Universal Time (UTC).
+    },
+    "standardDeviationMilliseconds": 3.14, # Optional. The standard deviation of the heart rate variability measurement.
+  },
+  "hydrationLog": { # Holds information about a user logged hydration. # Optional. Data for points in the `hydration-log` session data type collection.
+    "amountConsumed": { # Represents the volume quantity. # Required. Amount of liquid (ex. water) consumed.
+      "milliliters": 3.14, # Required. Value representing the volume in milliliters.
+      "userProvidedUnit": "A String", # Optional. Value representing the user provided unit.
+    },
+    "interval": { # Represents a time interval of session data point, which bundles multiple observed metrics together. # Required. Observed interval.
+      "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Session end time in civil time in the timezone the subject is in at the end of the session.
+        "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+          "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+          "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+          "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+        },
+        "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+          "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+          "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+          "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+          "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+        },
+      },
+      "civilStartTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Session start time in civil time in the timezone the subject is in at the start of the session.
+        "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+          "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+          "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+          "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+        },
+        "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+          "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+          "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+          "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+          "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+        },
+      },
+      "endTime": "A String", # Required. The end time of the observed session.
+      "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the session relative to the Coordinated Universal Time (UTC).
+      "startTime": "A String", # Required. The start time of the observed session.
+      "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the session relative to the Coordinated Universal Time (UTC).
+    },
+  },
+  "name": "A String", # Identifier. Data point name, only supported for the subset of identifiable data types. For the majority of the data types, individual data points do not need to be identified and this field would be empty. Format: `users/{user}/dataTypes/{data_type}/dataPoints/{data_point}` Example: `users/abcd1234/dataTypes/sleep/dataPoints/a1b2c3d4-e5f6-7890-1234-567890abcdef` The `{user}` ID is a system-generated identifier, as described in Identity.health_user_id. The `{data_type}` ID corresponds to the kebab-case version of the field names in the DataPoint data union field, e.g. `total-calories` for the `total_calories` field. The `{data_point}` ID can be client-provided or system-generated. If client-provided, it must be a string of 4-63 characters, containing only lowercase letters, numbers, and hyphens.
+  "oxygenSaturation": { # Captures the user's instantaneous oxygen saturation percentage (SpO2). # Optional. Data for points in the `oxygen-saturation` sample data type collection.
+    "percentage": 3.14, # Required. The oxygen saturation percentage. Valid values are from 0 to 100.
+    "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which oxygen saturation was measured.
+      "civilTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. The civil time in the timezone the subject is in at the time of the observation.
+        "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+          "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+          "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+          "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+        },
+        "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+          "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+          "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+          "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+          "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+        },
+      },
+      "physicalTime": "A String", # Required. The time of the observation.
+      "utcOffset": "A String", # Required. The offset of the user's local time during the observation relative to the Coordinated Universal Time (UTC).
+    },
+  },
+  "respiratoryRateSleepSummary": { # Records respiratory rate details during sleep. Can have multiple per day if the user sleeps multiple times. # Optional. Data for points in the `respiratory-rate-sleep-summary` sample data type collection.
+    "deepSleepStats": { # Respiratory rate statistics for a given sleep stage. # Optional. Respiratory rate statistics for deep sleep.
+      "breathsPerMinute": 3.14, # Required. Average breaths per minute.
+      "signalToNoise": 3.14, # Optional. How trustworthy the data is for the computation.
+      "standardDeviation": 3.14, # Optional. Standard deviation of the respiratory rate during sleep.
+    },
+    "fullSleepStats": { # Respiratory rate statistics for a given sleep stage. # Required. Full respiratory rate statistics.
+      "breathsPerMinute": 3.14, # Required. Average breaths per minute.
+      "signalToNoise": 3.14, # Optional. How trustworthy the data is for the computation.
+      "standardDeviation": 3.14, # Optional. Standard deviation of the respiratory rate during sleep.
+    },
+    "lightSleepStats": { # Respiratory rate statistics for a given sleep stage. # Optional. Respiratory rate statistics for light sleep.
+      "breathsPerMinute": 3.14, # Required. Average breaths per minute.
+      "signalToNoise": 3.14, # Optional. How trustworthy the data is for the computation.
+      "standardDeviation": 3.14, # Optional. Standard deviation of the respiratory rate during sleep.
+    },
+    "remSleepStats": { # Respiratory rate statistics for a given sleep stage. # Optional. Respiratory rate statistics for REM sleep.
+      "breathsPerMinute": 3.14, # Required. Average breaths per minute.
+      "signalToNoise": 3.14, # Optional. How trustworthy the data is for the computation.
+      "standardDeviation": 3.14, # Optional. Standard deviation of the respiratory rate during sleep.
+    },
+    "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which respiratory rate was measured.
+      "civilTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. The civil time in the timezone the subject is in at the time of the observation.
+        "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+          "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+          "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+          "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+        },
+        "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+          "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+          "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+          "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+          "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+        },
+      },
+      "physicalTime": "A String", # Required. The time of the observation.
+      "utcOffset": "A String", # Required. The offset of the user's local time during the observation relative to the Coordinated Universal Time (UTC).
+    },
+  },
+  "runVo2Max": { # VO2 max value calculated based on the user's running activity. Value stored in ml/kg/min. # Optional. Data for points in the `run-vo2-max` sample data type collection.
+    "runVo2Max": 3.14, # Required. Run VO2 max value in ml/kg/min.
+    "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which the metric was measured.
+      "civilTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. The civil time in the timezone the subject is in at the time of the observation.
+        "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+          "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+          "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+          "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+        },
+        "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+          "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+          "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+          "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+          "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+        },
+      },
+      "physicalTime": "A String", # Required. The time of the observation.
+      "utcOffset": "A String", # Required. The offset of the user's local time during the observation relative to the Coordinated Universal Time (UTC).
+    },
+  },
+  "sedentaryPeriod": { # SedentaryPeriod SedentaryPeriod data represents the periods of time that the user was sedentary (i.e. not moving while wearing the device). # Optional. Data for points in the `sedentary-period` interval data type collection.
+    "interval": { # Represents a time interval of an observed data point. # Required. Observed interval.
+      "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval end time in civil time in the timezone the subject is in at the end of the observed interval
+        "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+          "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+          "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+          "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+        },
+        "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+          "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+          "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+          "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+          "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+        },
+      },
+      "civilStartTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval start time in civil time in the timezone the subject is in at the start of the observed interval
+        "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+          "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+          "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+          "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+        },
+        "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+          "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+          "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+          "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+          "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+        },
+      },
+      "endTime": "A String", # Required. Observed interval end time.
+      "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the observation relative to the Coordinated Universal Time (UTC).
+      "startTime": "A String", # Required. Observed interval start time.
+      "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the observation relative to the Coordinated Universal Time (UTC).
+    },
+  },
+  "sleep": { # A sleep session possibly including stages. # Optional. Data for points in the `sleep` session data type collection.
+    "createTime": "A String", # Output only. Creation time of this sleep observation.
+    "interval": { # Represents a time interval of session data point, which bundles multiple observed metrics together. # Required. Observed sleep interval.
+      "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Session end time in civil time in the timezone the subject is in at the end of the session.
+        "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+          "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+          "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+          "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+        },
+        "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+          "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+          "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+          "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+          "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+        },
+      },
+      "civilStartTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Session start time in civil time in the timezone the subject is in at the start of the session.
+        "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+          "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+          "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+          "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+        },
+        "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+          "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+          "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+          "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+          "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+        },
+      },
+      "endTime": "A String", # Required. The end time of the observed session.
+      "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the session relative to the Coordinated Universal Time (UTC).
+      "startTime": "A String", # Required. The start time of the observed session.
+      "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the session relative to the Coordinated Universal Time (UTC).
+    },
+    "metadata": { # Additional information about how the sleep was processed. # Optional. Sleep metadata: processing, main, manually edited, stages status.
+      "externalId": "A String", # Optional. Sleep identifier relevant in the context of the data source.
+      "manuallyEdited": True or False, # Output only. Some sleeps autodetected by algorithms can be manually edited by users.
+      "nap": True or False, # Output only. Naps are sleeps without stages and relatively short durations.
+      "processed": True or False, # Output only. Sleep and sleep stages algorithms finished processing.
+      "stagesStatus": "A String", # Output only. Sleep stages algorithm processing status.
+    },
+    "outOfBedSegments": [ # Optional. “Out of bed” segments that can overlap with sleep stages.
+      { # A time interval to represent an out-of-bed segment.
+        "endTime": "A String", # Required. Segment end time.
+        "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the segment relative to the Coordinated Universal Time (UTC).
+        "startTime": "A String", # Required. Segment tart time.
+        "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the segment relative to the Coordinated Universal Time (UTC).
+      },
+    ],
+    "stages": [ # Optional. List of non-overlapping contiguous sleep stage segments that cover the sleep period.
+      { # Sleep stage segment.
+        "createTime": "A String", # Output only. Creation time of this sleep stages segment.
+        "endTime": "A String", # Required. Sleep stage end time.
+        "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the sleep stage relative to the Coordinated Universal Time (UTC).
+        "startTime": "A String", # Required. Sleep stage start time.
+        "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the sleep stage relative to the Coordinated Universal Time (UTC).
+        "type": "A String", # Required. Sleep stage type: AWAKE, DEEP, REM, LIGHT etc.
+        "updateTime": "A String", # Output only. Last update time of this sleep stages segment.
+      },
+    ],
+    "summary": { #  Sleep summary: metrics and stages summary. # Output only. Sleep summary: metrics and stages summary.
+      "minutesAfterWakeUp": "A String", # Output only. Minutes after wake up calculated by restlessness algorithm.
+      "minutesAsleep": "A String", # Output only. Total number of minutes asleep. For classic sleep it is the sum of ASLEEP stages (excluding AWAKE and RESTLESS). For "stages" sleep it is the sum of LIGHT, REM and DEEP stages (excluding AWAKE).
+      "minutesAwake": "A String", # Output only. Total number of minutes awake. It is a sum of all AWAKE stages.
+      "minutesInSleepPeriod": "A String", # Output only. Delta between wake time and bedtime. It is the sum of all stages.
+      "minutesToFallAsleep": "A String", # Output only. Minutes to fall asleep calculated by restlessness algorithm.
+      "stagesSummary": [ # Output only. List of summaries (total duration and segment count) per each sleep stage type.
+        { # Total duration and segment count for a stage.
+          "count": "A String", # Output only. Number of sleep stages segments.
+          "minutes": "A String", # Output only. Total duration in minutes of a sleep stage.
+          "type": "A String", # Output only. Sleep stage type: AWAKE, DEEP, REM, LIGHT etc.
+        },
+      ],
+    },
+    "type": "A String", # Optional. SleepType: classic or stages.
+    "updateTime": "A String", # Output only. Last update time of this sleep observation.
+  },
+  "steps": { # Step count over the time interval. # Optional. Data for points in the `steps` interval data type collection.
+    "count": "A String", # Required. Number of steps in the recorded interval.
+    "interval": { # Represents a time interval of an observed data point. # Required. Observed interval.
+      "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval end time in civil time in the timezone the subject is in at the end of the observed interval
+        "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+          "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+          "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+          "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+        },
+        "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+          "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+          "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+          "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+          "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+        },
+      },
+      "civilStartTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval start time in civil time in the timezone the subject is in at the start of the observed interval
+        "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+          "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+          "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+          "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+        },
+        "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+          "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+          "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+          "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+          "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+        },
+      },
+      "endTime": "A String", # Required. Observed interval end time.
+      "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the observation relative to the Coordinated Universal Time (UTC).
+      "startTime": "A String", # Required. Observed interval start time.
+      "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the observation relative to the Coordinated Universal Time (UTC).
+    },
+  },
+  "timeInHeartRateZone": { # Time in heart rate zone record. It's an interval spent in specific heart rate zone. # Optional. Data for points in the `time-in-heart-rate-zone` interval data type collection.
+    "heartRateZoneType": "A String", # Required. Heart rate zone type.
+    "interval": { # Represents a time interval of an observed data point. # Required. Observed interval.
+      "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval end time in civil time in the timezone the subject is in at the end of the observed interval
+        "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+          "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+          "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+          "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+        },
+        "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+          "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+          "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+          "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+          "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+        },
+      },
+      "civilStartTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval start time in civil time in the timezone the subject is in at the start of the observed interval
+        "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+          "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+          "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+          "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+        },
+        "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+          "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+          "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+          "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+          "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+        },
+      },
+      "endTime": "A String", # Required. Observed interval end time.
+      "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the observation relative to the Coordinated Universal Time (UTC).
+      "startTime": "A String", # Required. Observed interval start time.
+      "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the observation relative to the Coordinated Universal Time (UTC).
+    },
+  },
+  "vo2Max": { # VO2 max measurement. # Optional. Data for points in the `vo2-max` sample data type collection.
+    "measurementMethod": "A String", # Optional. The method used to measure the VO2 max value.
+    "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which VO2 max was measured.
+      "civilTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. The civil time in the timezone the subject is in at the time of the observation.
+        "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+          "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+          "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+          "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+        },
+        "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+          "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+          "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+          "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+          "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+        },
+      },
+      "physicalTime": "A String", # Required. The time of the observation.
+      "utcOffset": "A String", # Required. The offset of the user's local time during the observation relative to the Coordinated Universal Time (UTC).
+    },
+    "vo2Max": 3.14, # Required. VO2 max value measured as in ml consumed oxygen / kg of body weight / min.
+  },
+  "weight": { # Body weight measurement. # Optional. Data for points in the `weight` sample data type collection.
+    "notes": "A String", # Optional. Standard free-form notes captured at manual logging.
+    "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which the weight was measured
+      "civilTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. The civil time in the timezone the subject is in at the time of the observation.
+        "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+          "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+          "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+          "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+        },
+        "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+          "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+          "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+          "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+          "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+        },
+      },
+      "physicalTime": "A String", # Required. The time of the observation.
+      "utcOffset": "A String", # Required. The offset of the user's local time during the observation relative to the Coordinated Universal Time (UTC).
+    },
+    "weightGrams": 3.14, # Required. Weight of a user in grams.
+  },
+}
+
+  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, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ reconcile(parent, dataSourceFamily=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None) +
Reconcile data points from multiple data sources into a single data stream.
+
+Args:
+  parent: string, Required. Parent data type of the Data Point collection. Format: `users/me/dataTypes/{data_type}`, e.g.: - `users/me/dataTypes/steps` - `users/me/dataTypes/heart-rate` For a list of the supported data types see the DataPoint data union field. (required)
+  dataSourceFamily: string, Optional. The data source family name to reconcile. If empty, data points from all data sources will be reconciled. Format: `users/me/dataSourceFamilies/{data_source_family}` The supported values are: - `users/me/dataSourceFamilies/all-sources` - default value - `users/me/dataSourceFamilies/google-wearables` - tracker devices - `users/me/dataSourceFamilies/google-sources` - Google first party sources
+  filter: string, Optional. Filter expression based on https://aip.dev/160. A time range, either physical or civil, can be specified. See the ListDataPointsRequest.filter for the supported fields and syntax.
+  pageSize: integer, Optional. The maximum number of data points to return. If unspecified, at most 1440 data points will be returned. The maximum page size is 10000; values above that will be truncated accordingly. For `exercise` and `sleep` the default page size is 25. The maximum page size for `exercise` and `sleep` is 25.
+  pageToken: string, Optional. The `next_page_token` from a previous request, if any.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response containing the list of reconciled DataPoints.
+  "dataPoints": [ # Data points matching the query
+    { # A reconciled computed or recorded metric.
+      "activeMinutes": { # Record of active minutes in a given time interval. # Data for points in the `active-minutes` interval data type collection.
+        "activeMinutesByActivityLevel": [ # Required. Active minutes by activity level. At most one record per activity level is allowed.
+          { # Active minutes at a given activity level.
+            "activeMinutes": "A String", # Required. Number of whole minutes spent in activity.
+            "activityLevel": "A String", # Required. The level of activity.
+          },
+        ],
+        "interval": { # Represents a time interval of an observed data point. # Required. Observed interval.
+          "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval end time in civil time in the timezone the subject is in at the end of the observed interval
+            "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+              "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+              "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+              "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+            },
+            "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+              "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+              "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+              "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+          },
+          "civilStartTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval start time in civil time in the timezone the subject is in at the start of the observed interval
+            "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+              "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+              "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+              "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+            },
+            "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+              "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+              "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+              "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+          },
+          "endTime": "A String", # Required. Observed interval end time.
+          "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the observation relative to the Coordinated Universal Time (UTC).
+          "startTime": "A String", # Required. Observed interval start time.
+          "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the observation relative to the Coordinated Universal Time (UTC).
+        },
+      },
+      "activeZoneMinutes": { # Record of active zone minutes in a given time interval. # Data for points in the `active-zone-minutes` interval data type collection, measured in minutes.
+        "activeZoneMinutes": "A String", # Required. Number of Active Zone Minutes earned in the given time interval. Note: active_zone_minutes equals to 1 for low intensity (fat burn) zones or 2 for high intensity zones (cardio, peak).
+        "heartRateZone": "A String", # Required. Heart rate zone in which the active zone minutes have been earned, in the given time interval.
+        "interval": { # Represents a time interval of an observed data point. # Required. Observed interval.
+          "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval end time in civil time in the timezone the subject is in at the end of the observed interval
+            "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+              "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+              "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+              "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+            },
+            "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+              "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+              "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+              "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+          },
+          "civilStartTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval start time in civil time in the timezone the subject is in at the start of the observed interval
+            "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+              "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+              "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+              "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+            },
+            "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+              "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+              "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+              "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+          },
+          "endTime": "A String", # Required. Observed interval end time.
+          "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the observation relative to the Coordinated Universal Time (UTC).
+          "startTime": "A String", # Required. Observed interval start time.
+          "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the observation relative to the Coordinated Universal Time (UTC).
+        },
+      },
+      "activityLevel": { # Internal type to capture activity level during a certain time interval. # Data for points in the `activity-level` daily data type collection.
+        "activityLevelType": "A String", # Required. Activity level type in the given time interval.
+        "interval": { # Represents a time interval of an observed data point. # Required. Observed interval.
+          "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval end time in civil time in the timezone the subject is in at the end of the observed interval
+            "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+              "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+              "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+              "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+            },
+            "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+              "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+              "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+              "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+          },
+          "civilStartTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval start time in civil time in the timezone the subject is in at the start of the observed interval
+            "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+              "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+              "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+              "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+            },
+            "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+              "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+              "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+              "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+          },
+          "endTime": "A String", # Required. Observed interval end time.
+          "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the observation relative to the Coordinated Universal Time (UTC).
+          "startTime": "A String", # Required. Observed interval start time.
+          "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the observation relative to the Coordinated Universal Time (UTC).
+        },
+      },
+      "altitude": { # Captures the altitude gain (i.e. deltas), and not level above sea, for a user in millimeters. # Data for points in the `altitude` interval data type collection.
+        "gainMillimeters": "A String", # Required. Altitude gain in millimeters over the observed interval.
+        "interval": { # Represents a time interval of an observed data point. # Required. Observed interval.
+          "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval end time in civil time in the timezone the subject is in at the end of the observed interval
+            "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+              "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+              "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+              "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+            },
+            "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+              "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+              "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+              "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+          },
+          "civilStartTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval start time in civil time in the timezone the subject is in at the start of the observed interval
+            "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+              "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+              "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+              "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+            },
+            "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+              "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+              "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+              "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+          },
+          "endTime": "A String", # Required. Observed interval end time.
+          "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the observation relative to the Coordinated Universal Time (UTC).
+          "startTime": "A String", # Required. Observed interval start time.
+          "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the observation relative to the Coordinated Universal Time (UTC).
+        },
+      },
+      "bodyFat": { # Body fat measurement. # Data for points in the `body-fat` sample data type collection.
+        "percentage": 3.14, # Required. Body fat percentage, in range [0, 100].
+        "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which body fat was measured.
+          "civilTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. The civil time in the timezone the subject is in at the time of the observation.
+            "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+              "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+              "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+              "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+            },
+            "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+              "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+              "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+              "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+          },
+          "physicalTime": "A String", # Required. The time of the observation.
+          "utcOffset": "A String", # Required. The offset of the user's local time during the observation relative to the Coordinated Universal Time (UTC).
+        },
+      },
+      "dailyHeartRateVariability": { # Represents the daily heart rate variability data type. At least one of the following fields must be set: - `average_heart_rate_variability_milliseconds` - `non_rem_heart_rate_beats_per_minute` - `entropy` - `deep_sleep_root_mean_square_of_successive_differences_milliseconds` # Data for points in the `daily-heart-rate-variability` daily data type collection.
+        "averageHeartRateVariabilityMilliseconds": 3.14, # Optional. A user's average heart rate variability calculated using the root mean square of successive differences (RMSSD) in times between heartbeats.
+        "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Date (in the user's timezone) of heart rate variability measurement.
+          "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+          "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+          "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+        },
+        "deepSleepRootMeanSquareOfSuccessiveDifferencesMilliseconds": 3.14, # Optional. The root mean square of successive differences (RMSSD) value during deep sleep.
+        "entropy": 3.14, # Optional. The Shanon entropy of heartbeat intervals. Entropy quantifies randomness or disorder in a system. High entropy indicates high HRV. Entropy is measured from the histogram of time interval between successive heart beats values measured during sleep.
+        "nonRemHeartRateBeatsPerMinute": "A String", # Optional. Non-REM heart rate
+      },
+      "dailyHeartRateZones": { # User's heart rate zone thresholds based on the Karvonen algorithm for a specific day. # Data for points in the `daily-heart-rate-zones` daily data type collection.
+        "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Date (in user's timezone) of the heart rate zones record.
+          "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+          "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+          "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+        },
+        "heartRateZones": [ # Required. The heart rate zones.
+          { # The heart rate zone.
+            "heartRateZoneType": "A String", # Required. The heart rate zone type.
+            "maxBeatsPerMinute": "A String", # Required. Maximum heart rate for this zone in beats per minute.
+            "minBeatsPerMinute": "A String", # Required. Minimum heart rate for this zone in beats per minute.
+          },
+        ],
+      },
+      "dailyOxygenSaturation": { # A daily oxygen saturation (SpO2) record. Represents the user's daily oxygen saturation summary, typically calculated during sleep. # Data for points in the `daily-oxygen-saturation` daily data type collection.
+        "averagePercentage": 3.14, # Required. The average value of the oxygen saturation samples during the sleep.
+        "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Date (in user's timezone) of the daily oxygen saturation record.
+          "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+          "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+          "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+        },
+        "lowerBoundPercentage": 3.14, # Required. The lower bound of the confidence interval of oxygen saturation samples during sleep.
+        "standardDeviationPercentage": 3.14, # Optional. Standard deviation of the daily oxygen saturation averages from the past 7-30 days.
+        "upperBoundPercentage": 3.14, # Required. The upper bound of the confidence interval of oxygen saturation samples during sleep.
+      },
+      "dailyRespiratoryRate": { # A daily average respiratory rate (breaths per minute) for a day of the year. One data point per day calculated for the main sleep. # Data for points in the `daily-respiratory-rate` daily data type collection.
+        "breathsPerMinute": 3.14, # Required. The average number of breaths taken per minute.
+        "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. The date on which the respiratory rate was measured.
+          "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+          "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+          "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+        },
+      },
+      "dailyRestingHeartRate": { # Measures the daily resting heart rate for a user, calculated using the all day heart rate measurements. # Data for points in the `daily-resting-heart-rate` daily data type collection.
+        "beatsPerMinute": "A String", # Required. The resting heart rate value in beats per minute.
+        "dailyRestingHeartRateMetadata": { # Metadata for the daily resting heart rate. # Optional. Metadata for the daily resting heart rate.
+          "calculationMethod": "A String", # Required. The method used to calculate the resting heart rate.
+        },
+        "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Date (in the user's timezone) of the resting heart rate measurement.
+          "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+          "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+          "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+        },
+      },
+      "dailySleepTemperatureDerivations": { # Provides derived sleep temperature values, calculated from skin or internal device temperature readings during sleep. # Data for points in the `daily-sleep-temperature-derivations` daily data type collection.
+        "baselineTemperatureCelsius": 3.14, # Optional. The user's baseline skin temperature. It is the median of the user's nightly skin temperature over the past 30 days.
+        "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Date for which the sleep temperature derivations are calculated.
+          "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+          "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+          "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+        },
+        "nightlyTemperatureCelsius": 3.14, # Required. The user's nightly skin temperature. It is the mean of skin temperature samples taken from the user’s sleep.
+        "relativeNightlyStddev30dCelsius": 3.14, # Optional. The standard deviation of the user’s relative nightly skin temperature (temperature - baseline) over the past 30 days.
+      },
+      "dailyVo2Max": { # Contains a daily summary of the user's VO2 max (cardio fitness score), which is the maximum rate of oxygen the body can use during exercise. # Data for points in the `daily-vo2-max` daily data type collection.
+        "cardioFitnessLevel": "A String", # Optional. Represents the user's cardio fitness level based on their VO2 max.
+        "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. The date for which the Daily VO2 max was measured.
+          "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+          "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+          "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+        },
+        "estimated": True or False, # Optional. An estimated field is added to indicate when the confidence has decreased sufficiently to consider the value an estimation.
+        "vo2Max": 3.14, # Required. Daily VO2 max value measured as in ml consumed oxygen / kg of body weight / min.
+        "vo2MaxCovariance": 3.14, # Optional. The covariance of the VO2 max value.
+      },
+      "dataPointName": "A String", # Identifier. Data point name, only supported for the subset of identifiable data types. For the majority of the data types, individual data points do not need to be identified and this field would be empty. Format: `users/{user}/dataTypes/{data_type}/dataPoints/{data_point}` Example: `users/abcd1234/dataTypes/sleep/dataPoints/a1b2c3d4-e5f6-7890-1234-567890abcdef` The `{user}` ID is a system-generated identifier, as described in Identity.health_user_id. The `{data_type}` ID corresponds to the kebab-case version of the field names in the DataPoint data union field, e.g. `total-calories` for the `total_calories` field. The `{data_point}` ID can be client-provided or system-generated. If client-provided, it must be a string of 4-63 characters, containing only lowercase letters, numbers, and hyphens.
+      "distance": { # Distance traveled over an interval of time. # Data for points in the `distance` interval data type collection.
+        "interval": { # Represents a time interval of an observed data point. # Required. Observed interval.
+          "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval end time in civil time in the timezone the subject is in at the end of the observed interval
+            "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+              "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+              "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+              "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+            },
+            "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+              "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+              "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+              "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+          },
+          "civilStartTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval start time in civil time in the timezone the subject is in at the start of the observed interval
+            "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+              "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+              "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+              "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+            },
+            "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+              "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+              "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+              "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+          },
+          "endTime": "A String", # Required. Observed interval end time.
+          "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the observation relative to the Coordinated Universal Time (UTC).
+          "startTime": "A String", # Required. Observed interval start time.
+          "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the observation relative to the Coordinated Universal Time (UTC).
+        },
+        "millimeters": "A String", # Required. Distance in millimeters over the observed interval.
+      },
+      "exercise": { # An exercise that stores information about a physical activity. # Data for points in the `exercise` session data type collection.
+        "activeDuration": "A String", # Optional. Duration excluding pauses.
+        "createTime": "A String", # Output only. Represents the timestamp of the creation of the exercise.
+        "displayName": "A String", # Required. Exercise display name.
+        "exerciseEvents": [ # Optional. Exercise events that happen during an exercise, such as pause & restarts.
+          { # Represents instantaneous events that happen during an exercise, such as start, stop, pause, split.
+            "eventTime": "A String", # Required. Exercise event time
+            "eventUtcOffset": "A String", # Required. Exercise event time offset from UTC
+            "exerciseEventType": "A String", # Required. The type of the event, such as start, stop, pause, resume.
+          },
+        ],
+        "exerciseMetadata": { # Additional exercise metadata. # Optional. Additional exercise metadata.
+          "hasGps": True or False, # Optional. Whether the exercise had GPS tracking.
+          "poolLengthMillimeters": "A String", # Optional. Pool length in millimeters. Only present in the swimming exercises.
+        },
+        "exerciseType": "A String", # Required. The type of activity performed during an exercise.
+        "interval": { # Represents a time interval of session data point, which bundles multiple observed metrics together. # Required. Observed exercise interval
+          "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Session end time in civil time in the timezone the subject is in at the end of the session.
+            "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+              "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+              "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+              "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+            },
+            "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+              "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+              "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+              "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+          },
+          "civilStartTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Session start time in civil time in the timezone the subject is in at the start of the session.
+            "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+              "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+              "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+              "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+            },
+            "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+              "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+              "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+              "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+          },
+          "endTime": "A String", # Required. The end time of the observed session.
+          "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the session relative to the Coordinated Universal Time (UTC).
+          "startTime": "A String", # Required. The start time of the observed session.
+          "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the session relative to the Coordinated Universal Time (UTC).
+        },
+        "metricsSummary": { # Summary metrics for an exercise. # Required. Summary metrics for this exercise ( )
+          "activeZoneMinutes": "A String", # Optional. Total active zone minutes for the exercise.
+          "averageHeartRateBeatsPerMinute": "A String", # Optional. Average heart rate during the exercise.
+          "averagePaceSecondsPerMeter": 3.14, # Optional. Average pace in seconds per meter.
+          "averageSpeedMillimetersPerSecond": 3.14, # Optional. Average speed in millimeters per second.
+          "caloriesKcal": 3.14, # Optional. Total calories burned by the user during the exercise.
+          "distanceMillimeters": 3.14, # Optional. Total distance covered by the user during the exercise.
+          "elevationGainMillimeters": 3.14, # Optional. Total elevation gain during the exercise.
+          "heartRateZoneDurations": { # Time spent in each heart rate zone. # Optional. Time spent in each heart rate zone.
+            "lightTime": "A String", # Optional. Time spent in light heart rate zone.
+            "moderateTime": "A String", # Optional. Time spent in moderate heart rate zone.
+            "peakTime": "A String", # Optional. Time spent in peak heart rate zone.
+            "vigorousTime": "A String", # Optional. Time spent in vigorous heart rate zone.
+          },
+          "mobilityMetrics": { # Mobility workouts specific metrics # Optional. Mobility workouts specific metrics. Only present in the advanced running exercises.
+            "avgCadenceStepsPerMinute": 3.14, # Optional. Cadence is a measure of the frequency of your foot strikes. Steps / min in real time during workout.
+            "avgGroundContactTimeDuration": "A String", # Optional. The ground contact time for a particular stride is the amount of time for which the foot was in contact with the ground on that stride
+            "avgStrideLengthMillimeters": "A String", # Optional. Stride length is a measure of the distance covered by a single stride
+            "avgVerticalOscillationMillimeters": "A String", # Optional. Distance off the ground your center of mass moves with each stride while running
+            "avgVerticalRatio": 3.14, # Optional. Vertical oscillation/stride length between [5.0, 11.0].
+          },
+          "runVo2Max": 3.14, # Optional. Run VO2 max value for the exercise. Only present in the running exercises at the top level as in the summary of the whole exercise.
+          "steps": "A String", # Optional. Total steps taken during the exercise.
+          "totalSwimLengths": 3.14, # Optional. Number of full pool lengths completed during the exercise. Only present in the swimming exercises at the top level as in the summary of the whole exercise.
+        },
+        "notes": "A String", # Optional. Standard free-form notes captured at manual logging.
+        "splitSummaries": [ # Optional. Laps or splits recorded within an exercise. Laps could be split based on distance or other criteria (duration, etc.) Laps should not be overlapping with each other.
+          { # Represents splits or laps recorded within an exercise. Lap events partition a workout into segments based on criteria like distance, time, or calories.
+            "activeDuration": "A String", # Output only. Lap time excluding the pauses.
+            "endTime": "A String", # Required. Lap end time
+            "endUtcOffset": "A String", # Required. Lap end time offset from UTC
+            "metricsSummary": { # Summary metrics for an exercise. # Required. Summary metrics for this split.
+              "activeZoneMinutes": "A String", # Optional. Total active zone minutes for the exercise.
+              "averageHeartRateBeatsPerMinute": "A String", # Optional. Average heart rate during the exercise.
+              "averagePaceSecondsPerMeter": 3.14, # Optional. Average pace in seconds per meter.
+              "averageSpeedMillimetersPerSecond": 3.14, # Optional. Average speed in millimeters per second.
+              "caloriesKcal": 3.14, # Optional. Total calories burned by the user during the exercise.
+              "distanceMillimeters": 3.14, # Optional. Total distance covered by the user during the exercise.
+              "elevationGainMillimeters": 3.14, # Optional. Total elevation gain during the exercise.
+              "heartRateZoneDurations": { # Time spent in each heart rate zone. # Optional. Time spent in each heart rate zone.
+                "lightTime": "A String", # Optional. Time spent in light heart rate zone.
+                "moderateTime": "A String", # Optional. Time spent in moderate heart rate zone.
+                "peakTime": "A String", # Optional. Time spent in peak heart rate zone.
+                "vigorousTime": "A String", # Optional. Time spent in vigorous heart rate zone.
+              },
+              "mobilityMetrics": { # Mobility workouts specific metrics # Optional. Mobility workouts specific metrics. Only present in the advanced running exercises.
+                "avgCadenceStepsPerMinute": 3.14, # Optional. Cadence is a measure of the frequency of your foot strikes. Steps / min in real time during workout.
+                "avgGroundContactTimeDuration": "A String", # Optional. The ground contact time for a particular stride is the amount of time for which the foot was in contact with the ground on that stride
+                "avgStrideLengthMillimeters": "A String", # Optional. Stride length is a measure of the distance covered by a single stride
+                "avgVerticalOscillationMillimeters": "A String", # Optional. Distance off the ground your center of mass moves with each stride while running
+                "avgVerticalRatio": 3.14, # Optional. Vertical oscillation/stride length between [5.0, 11.0].
+              },
+              "runVo2Max": 3.14, # Optional. Run VO2 max value for the exercise. Only present in the running exercises at the top level as in the summary of the whole exercise.
+              "steps": "A String", # Optional. Total steps taken during the exercise.
+              "totalSwimLengths": 3.14, # Optional. Number of full pool lengths completed during the exercise. Only present in the swimming exercises at the top level as in the summary of the whole exercise.
+            },
+            "splitType": "A String", # Required. Method used to split the exercise laps. Users may manually mark the lap as complete even if the tracking is automatic.
+            "startTime": "A String", # Required. Lap start time
+            "startUtcOffset": "A String", # Required. Lap start time offset from UTC
+          },
+        ],
+        "splits": [ # Optional. The default split is 1 km or 1 mile. - if the movement distance is less than the default, then there are no splits - if the movement distance is greater than or equal to the default, then we have splits
+          { # Represents splits or laps recorded within an exercise. Lap events partition a workout into segments based on criteria like distance, time, or calories.
+            "activeDuration": "A String", # Output only. Lap time excluding the pauses.
+            "endTime": "A String", # Required. Lap end time
+            "endUtcOffset": "A String", # Required. Lap end time offset from UTC
+            "metricsSummary": { # Summary metrics for an exercise. # Required. Summary metrics for this split.
+              "activeZoneMinutes": "A String", # Optional. Total active zone minutes for the exercise.
+              "averageHeartRateBeatsPerMinute": "A String", # Optional. Average heart rate during the exercise.
+              "averagePaceSecondsPerMeter": 3.14, # Optional. Average pace in seconds per meter.
+              "averageSpeedMillimetersPerSecond": 3.14, # Optional. Average speed in millimeters per second.
+              "caloriesKcal": 3.14, # Optional. Total calories burned by the user during the exercise.
+              "distanceMillimeters": 3.14, # Optional. Total distance covered by the user during the exercise.
+              "elevationGainMillimeters": 3.14, # Optional. Total elevation gain during the exercise.
+              "heartRateZoneDurations": { # Time spent in each heart rate zone. # Optional. Time spent in each heart rate zone.
+                "lightTime": "A String", # Optional. Time spent in light heart rate zone.
+                "moderateTime": "A String", # Optional. Time spent in moderate heart rate zone.
+                "peakTime": "A String", # Optional. Time spent in peak heart rate zone.
+                "vigorousTime": "A String", # Optional. Time spent in vigorous heart rate zone.
+              },
+              "mobilityMetrics": { # Mobility workouts specific metrics # Optional. Mobility workouts specific metrics. Only present in the advanced running exercises.
+                "avgCadenceStepsPerMinute": 3.14, # Optional. Cadence is a measure of the frequency of your foot strikes. Steps / min in real time during workout.
+                "avgGroundContactTimeDuration": "A String", # Optional. The ground contact time for a particular stride is the amount of time for which the foot was in contact with the ground on that stride
+                "avgStrideLengthMillimeters": "A String", # Optional. Stride length is a measure of the distance covered by a single stride
+                "avgVerticalOscillationMillimeters": "A String", # Optional. Distance off the ground your center of mass moves with each stride while running
+                "avgVerticalRatio": 3.14, # Optional. Vertical oscillation/stride length between [5.0, 11.0].
+              },
+              "runVo2Max": 3.14, # Optional. Run VO2 max value for the exercise. Only present in the running exercises at the top level as in the summary of the whole exercise.
+              "steps": "A String", # Optional. Total steps taken during the exercise.
+              "totalSwimLengths": 3.14, # Optional. Number of full pool lengths completed during the exercise. Only present in the swimming exercises at the top level as in the summary of the whole exercise.
+            },
+            "splitType": "A String", # Required. Method used to split the exercise laps. Users may manually mark the lap as complete even if the tracking is automatic.
+            "startTime": "A String", # Required. Lap start time
+            "startUtcOffset": "A String", # Required. Lap start time offset from UTC
+          },
+        ],
+        "updateTime": "A String", # Output only. This is the timestamp of the last update to the exercise.
+      },
+      "floors": { # Gained elevation measured in floors over the time interval # Data for points in the `floors` interval data type collection.
+        "count": "A String", # Required. Number of floors in the recorded interval
+        "interval": { # Represents a time interval of an observed data point. # Required. Observed interval
+          "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval end time in civil time in the timezone the subject is in at the end of the observed interval
+            "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+              "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+              "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+              "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+            },
+            "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+              "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+              "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+              "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+          },
+          "civilStartTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval start time in civil time in the timezone the subject is in at the start of the observed interval
+            "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+              "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+              "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+              "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+            },
+            "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+              "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+              "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+              "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+          },
+          "endTime": "A String", # Required. Observed interval end time.
+          "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the observation relative to the Coordinated Universal Time (UTC).
+          "startTime": "A String", # Required. Observed interval start time.
+          "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the observation relative to the Coordinated Universal Time (UTC).
+        },
+      },
+      "heartRate": { # A heart rate measurement. # Data for points in the `heart-rate` sample data type collection.
+        "beatsPerMinute": "A String", # Required. The heart rate value in beats per minute.
+        "metadata": { # Heart rate metadata. # Optional. Metadata about the heart rate sample.
+          "motionContext": "A String", # Optional. Indicates the user’s level of activity when the heart rate sample was measured
+          "sensorLocation": "A String", # Optional. Indicates the location of the sensor that measured the heart rate.
+        },
+        "sampleTime": { # Represents a sample time of an observed data point. # Required. Observation time
+          "civilTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. The civil time in the timezone the subject is in at the time of the observation.
+            "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+              "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+              "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+              "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+            },
+            "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+              "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+              "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+              "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+          },
+          "physicalTime": "A String", # Required. The time of the observation.
+          "utcOffset": "A String", # Required. The offset of the user's local time during the observation relative to the Coordinated Universal Time (UTC).
+        },
+      },
+      "heartRateVariability": { # Captures user's heart rate variability (HRV) as measured by the root mean square of successive differences (RMSSD) between normal heartbeats or by standard deviation of the inter-beat intervals (SDNN). # Data for points in the `heart-rate-variability` sample data type collection.
+        "rootMeanSquareOfSuccessiveDifferencesMilliseconds": 3.14, # Optional. The root mean square of successive differences between normal heartbeats. This is a measure of heart rate variability used by Fitbit.
+        "sampleTime": { # Represents a sample time of an observed data point. # Required. The time of the heart rate variability measurement.
+          "civilTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. The civil time in the timezone the subject is in at the time of the observation.
+            "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+              "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+              "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+              "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+            },
+            "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+              "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+              "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+              "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+          },
+          "physicalTime": "A String", # Required. The time of the observation.
+          "utcOffset": "A String", # Required. The offset of the user's local time during the observation relative to the Coordinated Universal Time (UTC).
+        },
+        "standardDeviationMilliseconds": 3.14, # Optional. The standard deviation of the heart rate variability measurement.
+      },
+      "hydrationLog": { # Holds information about a user logged hydration. # Data for points in the `hydration-log` session data type collection.
+        "amountConsumed": { # Represents the volume quantity. # Required. Amount of liquid (ex. water) consumed.
+          "milliliters": 3.14, # Required. Value representing the volume in milliliters.
+          "userProvidedUnit": "A String", # Optional. Value representing the user provided unit.
+        },
+        "interval": { # Represents a time interval of session data point, which bundles multiple observed metrics together. # Required. Observed interval.
+          "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Session end time in civil time in the timezone the subject is in at the end of the session.
+            "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+              "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+              "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+              "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+            },
+            "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+              "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+              "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+              "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+          },
+          "civilStartTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Session start time in civil time in the timezone the subject is in at the start of the session.
+            "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+              "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+              "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+              "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+            },
+            "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+              "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+              "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+              "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+          },
+          "endTime": "A String", # Required. The end time of the observed session.
+          "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the session relative to the Coordinated Universal Time (UTC).
+          "startTime": "A String", # Required. The start time of the observed session.
+          "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the session relative to the Coordinated Universal Time (UTC).
+        },
+      },
+      "oxygenSaturation": { # Captures the user's instantaneous oxygen saturation percentage (SpO2). # Data for points in the `oxygen-saturation` sample data type collection.
+        "percentage": 3.14, # Required. The oxygen saturation percentage. Valid values are from 0 to 100.
+        "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which oxygen saturation was measured.
+          "civilTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. The civil time in the timezone the subject is in at the time of the observation.
+            "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+              "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+              "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+              "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+            },
+            "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+              "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+              "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+              "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+          },
+          "physicalTime": "A String", # Required. The time of the observation.
+          "utcOffset": "A String", # Required. The offset of the user's local time during the observation relative to the Coordinated Universal Time (UTC).
+        },
+      },
+      "respiratoryRateSleepSummary": { # Records respiratory rate details during sleep. Can have multiple per day if the user sleeps multiple times. # Data for points in the `respiratory-rate-sleep-summary` sample data type collection.
+        "deepSleepStats": { # Respiratory rate statistics for a given sleep stage. # Optional. Respiratory rate statistics for deep sleep.
+          "breathsPerMinute": 3.14, # Required. Average breaths per minute.
+          "signalToNoise": 3.14, # Optional. How trustworthy the data is for the computation.
+          "standardDeviation": 3.14, # Optional. Standard deviation of the respiratory rate during sleep.
+        },
+        "fullSleepStats": { # Respiratory rate statistics for a given sleep stage. # Required. Full respiratory rate statistics.
+          "breathsPerMinute": 3.14, # Required. Average breaths per minute.
+          "signalToNoise": 3.14, # Optional. How trustworthy the data is for the computation.
+          "standardDeviation": 3.14, # Optional. Standard deviation of the respiratory rate during sleep.
+        },
+        "lightSleepStats": { # Respiratory rate statistics for a given sleep stage. # Optional. Respiratory rate statistics for light sleep.
+          "breathsPerMinute": 3.14, # Required. Average breaths per minute.
+          "signalToNoise": 3.14, # Optional. How trustworthy the data is for the computation.
+          "standardDeviation": 3.14, # Optional. Standard deviation of the respiratory rate during sleep.
+        },
+        "remSleepStats": { # Respiratory rate statistics for a given sleep stage. # Optional. Respiratory rate statistics for REM sleep.
+          "breathsPerMinute": 3.14, # Required. Average breaths per minute.
+          "signalToNoise": 3.14, # Optional. How trustworthy the data is for the computation.
+          "standardDeviation": 3.14, # Optional. Standard deviation of the respiratory rate during sleep.
+        },
+        "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which respiratory rate was measured.
+          "civilTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. The civil time in the timezone the subject is in at the time of the observation.
+            "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+              "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+              "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+              "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+            },
+            "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+              "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+              "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+              "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+          },
+          "physicalTime": "A String", # Required. The time of the observation.
+          "utcOffset": "A String", # Required. The offset of the user's local time during the observation relative to the Coordinated Universal Time (UTC).
+        },
+      },
+      "runVo2Max": { # VO2 max value calculated based on the user's running activity. Value stored in ml/kg/min. # Data for points in the `run-vo2-max` sample data type collection.
+        "runVo2Max": 3.14, # Required. Run VO2 max value in ml/kg/min.
+        "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which the metric was measured.
+          "civilTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. The civil time in the timezone the subject is in at the time of the observation.
+            "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+              "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+              "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+              "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+            },
+            "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+              "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+              "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+              "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+          },
+          "physicalTime": "A String", # Required. The time of the observation.
+          "utcOffset": "A String", # Required. The offset of the user's local time during the observation relative to the Coordinated Universal Time (UTC).
+        },
+      },
+      "sedentaryPeriod": { # SedentaryPeriod SedentaryPeriod data represents the periods of time that the user was sedentary (i.e. not moving while wearing the device). # Data for points in the `sedentary-period` interval data type collection.
+        "interval": { # Represents a time interval of an observed data point. # Required. Observed interval.
+          "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval end time in civil time in the timezone the subject is in at the end of the observed interval
+            "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+              "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+              "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+              "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+            },
+            "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+              "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+              "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+              "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+          },
+          "civilStartTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval start time in civil time in the timezone the subject is in at the start of the observed interval
+            "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+              "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+              "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+              "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+            },
+            "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+              "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+              "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+              "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+          },
+          "endTime": "A String", # Required. Observed interval end time.
+          "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the observation relative to the Coordinated Universal Time (UTC).
+          "startTime": "A String", # Required. Observed interval start time.
+          "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the observation relative to the Coordinated Universal Time (UTC).
+        },
+      },
+      "sleep": { # A sleep session possibly including stages. # Data for points in the `sleep` session data type collection.
+        "createTime": "A String", # Output only. Creation time of this sleep observation.
+        "interval": { # Represents a time interval of session data point, which bundles multiple observed metrics together. # Required. Observed sleep interval.
+          "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Session end time in civil time in the timezone the subject is in at the end of the session.
+            "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+              "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+              "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+              "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+            },
+            "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+              "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+              "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+              "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+          },
+          "civilStartTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Session start time in civil time in the timezone the subject is in at the start of the session.
+            "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+              "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+              "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+              "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+            },
+            "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+              "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+              "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+              "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+          },
+          "endTime": "A String", # Required. The end time of the observed session.
+          "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the session relative to the Coordinated Universal Time (UTC).
+          "startTime": "A String", # Required. The start time of the observed session.
+          "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the session relative to the Coordinated Universal Time (UTC).
+        },
+        "metadata": { # Additional information about how the sleep was processed. # Optional. Sleep metadata: processing, main, manually edited, stages status.
+          "externalId": "A String", # Optional. Sleep identifier relevant in the context of the data source.
+          "manuallyEdited": True or False, # Output only. Some sleeps autodetected by algorithms can be manually edited by users.
+          "nap": True or False, # Output only. Naps are sleeps without stages and relatively short durations.
+          "processed": True or False, # Output only. Sleep and sleep stages algorithms finished processing.
+          "stagesStatus": "A String", # Output only. Sleep stages algorithm processing status.
+        },
+        "outOfBedSegments": [ # Optional. “Out of bed” segments that can overlap with sleep stages.
+          { # A time interval to represent an out-of-bed segment.
+            "endTime": "A String", # Required. Segment end time.
+            "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the segment relative to the Coordinated Universal Time (UTC).
+            "startTime": "A String", # Required. Segment tart time.
+            "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the segment relative to the Coordinated Universal Time (UTC).
+          },
+        ],
+        "stages": [ # Optional. List of non-overlapping contiguous sleep stage segments that cover the sleep period.
+          { # Sleep stage segment.
+            "createTime": "A String", # Output only. Creation time of this sleep stages segment.
+            "endTime": "A String", # Required. Sleep stage end time.
+            "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the sleep stage relative to the Coordinated Universal Time (UTC).
+            "startTime": "A String", # Required. Sleep stage start time.
+            "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the sleep stage relative to the Coordinated Universal Time (UTC).
+            "type": "A String", # Required. Sleep stage type: AWAKE, DEEP, REM, LIGHT etc.
+            "updateTime": "A String", # Output only. Last update time of this sleep stages segment.
+          },
+        ],
+        "summary": { #  Sleep summary: metrics and stages summary. # Output only. Sleep summary: metrics and stages summary.
+          "minutesAfterWakeUp": "A String", # Output only. Minutes after wake up calculated by restlessness algorithm.
+          "minutesAsleep": "A String", # Output only. Total number of minutes asleep. For classic sleep it is the sum of ASLEEP stages (excluding AWAKE and RESTLESS). For "stages" sleep it is the sum of LIGHT, REM and DEEP stages (excluding AWAKE).
+          "minutesAwake": "A String", # Output only. Total number of minutes awake. It is a sum of all AWAKE stages.
+          "minutesInSleepPeriod": "A String", # Output only. Delta between wake time and bedtime. It is the sum of all stages.
+          "minutesToFallAsleep": "A String", # Output only. Minutes to fall asleep calculated by restlessness algorithm.
+          "stagesSummary": [ # Output only. List of summaries (total duration and segment count) per each sleep stage type.
+            { # Total duration and segment count for a stage.
+              "count": "A String", # Output only. Number of sleep stages segments.
+              "minutes": "A String", # Output only. Total duration in minutes of a sleep stage.
+              "type": "A String", # Output only. Sleep stage type: AWAKE, DEEP, REM, LIGHT etc.
+            },
+          ],
+        },
+        "type": "A String", # Optional. SleepType: classic or stages.
+        "updateTime": "A String", # Output only. Last update time of this sleep observation.
+      },
+      "steps": { # Step count over the time interval. # Data for points in the `steps` interval data type collection.
+        "count": "A String", # Required. Number of steps in the recorded interval.
+        "interval": { # Represents a time interval of an observed data point. # Required. Observed interval.
+          "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval end time in civil time in the timezone the subject is in at the end of the observed interval
+            "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+              "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+              "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+              "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+            },
+            "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+              "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+              "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+              "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+          },
+          "civilStartTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval start time in civil time in the timezone the subject is in at the start of the observed interval
+            "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+              "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+              "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+              "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+            },
+            "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+              "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+              "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+              "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+          },
+          "endTime": "A String", # Required. Observed interval end time.
+          "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the observation relative to the Coordinated Universal Time (UTC).
+          "startTime": "A String", # Required. Observed interval start time.
+          "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the observation relative to the Coordinated Universal Time (UTC).
+        },
+      },
+      "timeInHeartRateZone": { # Time in heart rate zone record. It's an interval spent in specific heart rate zone. # Data for points in the `time-in-heart-rate-zone` interval data type collection.
+        "heartRateZoneType": "A String", # Required. Heart rate zone type.
+        "interval": { # Represents a time interval of an observed data point. # Required. Observed interval.
+          "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval end time in civil time in the timezone the subject is in at the end of the observed interval
+            "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+              "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+              "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+              "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+            },
+            "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+              "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+              "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+              "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+          },
+          "civilStartTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval start time in civil time in the timezone the subject is in at the start of the observed interval
+            "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+              "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+              "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+              "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+            },
+            "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+              "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+              "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+              "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+          },
+          "endTime": "A String", # Required. Observed interval end time.
+          "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the observation relative to the Coordinated Universal Time (UTC).
+          "startTime": "A String", # Required. Observed interval start time.
+          "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the observation relative to the Coordinated Universal Time (UTC).
+        },
+      },
+      "vo2Max": { # VO2 max measurement. # Data for points in the `vo2-max` sample data type collection.
+        "measurementMethod": "A String", # Optional. The method used to measure the VO2 max value.
+        "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which VO2 max was measured.
+          "civilTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. The civil time in the timezone the subject is in at the time of the observation.
+            "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+              "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+              "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+              "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+            },
+            "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+              "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+              "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+              "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+          },
+          "physicalTime": "A String", # Required. The time of the observation.
+          "utcOffset": "A String", # Required. The offset of the user's local time during the observation relative to the Coordinated Universal Time (UTC).
+        },
+        "vo2Max": 3.14, # Required. VO2 max value measured as in ml consumed oxygen / kg of body weight / min.
+      },
+      "weight": { # Body weight measurement. # Data for points in the `weight` sample data type collection.
+        "notes": "A String", # Optional. Standard free-form notes captured at manual logging.
+        "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which the weight was measured
+          "civilTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. The civil time in the timezone the subject is in at the time of the observation.
+            "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date.
+              "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+              "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+              "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+            },
+            "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted.
+              "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+              "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+              "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+          },
+          "physicalTime": "A String", # Required. The time of the observation.
+          "utcOffset": "A String", # Required. The offset of the user's local time during the observation relative to the Coordinated Universal Time (UTC).
+        },
+        "weightGrams": 3.14, # Required. Weight of a user in grams.
+      },
+    },
+  ],
+  "nextPageToken": "A String", # Next page token, empty if the response is complete
+}
+
+ +
+ reconcile_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ rollUp(parent, body=None, x__xgafv=None) +
Roll up data points over physical time intervals for supported data types.
+
+Args:
+  parent: string, Required. Parent data type of the Data Point collection. Format: `users/{user}/dataTypes/{data_type}`, e.g.: - `users/me/dataTypes/steps` - `users/me/dataTypes/distance` For a list of the supported data types see the RollupDataPoint value union field. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request to roll up data points by physical time intervals.
+  "dataSourceFamily": "A String", # Optional. The data source family name to roll up. If empty, data points from all available data sources will be rolled up. Format: `users/me/dataSourceFamilies/{data_source_family}` The supported values are: - `users/me/dataSourceFamilies/all-sources` - default value - `users/me/dataSourceFamilies/google-wearables` - tracker devices - `users/me/dataSourceFamilies/google-sources` - Google first party sources
+  "pageSize": 42, # Optional. The maximum number of data points to return. If unspecified, at most 1440 data points will be returned. The maximum page size is 10000; values above that will be truncated accordingly.
+  "pageToken": "A String", # Optional. The next_page_token from a previous request, if any. All other request fields need to be the same as in the initial request when the page token is specified.
+  "range": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Required. Closed-open range of data points that will be rolled up. The maximum range for `calories-in-heart-rate-zone`, `heart-rate`, `active-minutes` and `total-calories` is 14 days. The maximum range for all other data types is 90 days.
+    "endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
+    "startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
+  },
+  "windowSize": "A String", # Required. The size of the time window to group data points into before applying the aggregation functions.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response containing the list of rolled up data points.
+  "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
+  "rollupDataPoints": [ # Values for each aggregation time window.
+    { # Value of a rollup for a single physical time interval (aggregation window)
+      "activeMinutes": { # Represents the result of the rollup of the active minutes data type. # Returned by default when rolling up data points from the `active-minutes` data type, or when requested explicitly using the `active-minutes` rollup type identifier.
+        "activeMinutesRollupByActivityLevel": [ # Active minutes by activity level. At most one record per activity level is allowed.
+          { # Active minutes by activity level.
+            "activeMinutesSum": "A String", # Number of whole minutes spent in activity.
+            "activityLevel": "A String", # The level of activity.
+          },
+        ],
+      },
+      "activeZoneMinutes": { # Represents the result of the rollup of the active zone minutes data type. # Returned by default when rolling up data points from the `active-zone-minutes` data type, or when requested explicitly using the `active-zone-minutes` rollup type identifier.
+        "sumInCardioHeartZone": "A String", # Active zone minutes in `HeartRateZone.CARDIO`.
+        "sumInFatBurnHeartZone": "A String", # Active zone minutes in `HeartRateZone.FAT_BURN`.
+        "sumInPeakHeartZone": "A String", # Active zone minutes in `HeartRateZone.PEAK`.
+      },
+      "activityLevel": { # Represents the result of the rollup of the activity level data type. # Returned by default when rolling up data points from the `activity-level` data type, or when requested explicitly using the `activity-level` rollup type identifier.
+        "activityLevelRollupsByActivityLevelType": [ # List of total durations in each activity level type.
+          { # Represents the total duration in a specific activity level type.
+            "activityLevelType": "A String", # Activity level type.
+            "totalDuration": "A String", # Total duration in the activity level type.
+          },
+        ],
+      },
+      "altitude": { # Represents the result of the rollup of the user's altitude. # Returned by default when rolling up data points from the `altitude` data type, or when requested explicitly using the `altitude` rollup type identifier.
+        "gainMillimetersSum": "A String", # Sum of the altitude gain in millimeters.
+      },
+      "bodyFat": { # Represents the result of the rollup of the body fat data type. # Returned by default when rolling up data points from the `body-fat` data type, or when requested explicitly using the `body-fat` rollup type identifier.
+        "bodyFatPercentageAvg": 3.14, # Average body fat percentage.
+      },
+      "caloriesInHeartRateZone": { # Represents the result of the rollup of the calories in heart rate zone data type. # Returned by default when rolling up data points from the `calories-in-heart-rate-zone` data type, or when requested explicitly using the `calories-in-heart-rate-zone` rollup type identifier.
+        "caloriesInHeartRateZones": [ # List of calories burned in each heart rate zone.
+          { # Represents the amount of kilocalories burned in a specific heart rate zone.
+            "heartRateZone": "A String", # The heart rate zone.
+            "kcal": 3.14, # The amount of kilocalories burned in the specified heart rate zone.
+          },
+        ],
+      },
+      "distance": { # Result of the rollup of the user's distance. # Returned by default when rolling up data points from the `distance` data type, or when requested explicitly using the `distance` rollup type identifier.
+        "millimetersSum": "A String", # Sum of the distance in millimeters.
+      },
+      "endTime": "A String", # End time of the window this value aggregates over
+      "floors": { # Represents the result of the rollup of the user's floors. # Returned by default when rolling up data points from the `floors` data type, or when requested explicitly using the `floors` rollup type identifier.
+        "countSum": "A String", # Sum of the floors count.
+      },
+      "heartRate": { # Represents the result of the rollup of the heart rate data type. # Returned by default when rolling up data points from the `heart-rate` data type, or when requested explicitly using the `heart-rate` rollup type identifier.
+        "beatsPerMinuteAvg": 3.14, # The average heart rate value in the interval.
+        "beatsPerMinuteMax": 3.14, # The maximum heart rate value in the interval.
+        "beatsPerMinuteMin": 3.14, # The minimum heart rate value in the interval.
+      },
+      "hydrationLog": { # Represents the result of the rollup of the hydration log data type. # Returned by default when rolling up data points from the `hydration-log` data type, or when requested explicitly using the `hydration-log` rollup type identifier.
+        "amountConsumed": { # Rollup for volume quantity. # Rollup for amount consumed.
+          "millilitersSum": 3.14, # Required. The sum of volume in milliliters.
+          "userProvidedUnitLast": "A String", # Optional. The user provided unit on the last element.
+        },
+      },
+      "runVo2Max": { # Represents the result of the rollup of the user's daily heart rate variability personal range. # Returned by default when rolling up data points from the `run-vo2-max` data type, or when requested explicitly using the `run-vo2-max` rollup type identifier.
+        "rateAvg": 3.14, # Average value of run VO2 max in the interval.
+        "rateMax": 3.14, # Maximum value of run VO2 max in the interval.
+        "rateMin": 3.14, # Minimum value of run VO2 max in the interval..
+      },
+      "sedentaryPeriod": { # Represents the result of the rollup of the user's sedentary periods. # Returned by default when rolling up data points from the `sedentary-period` data type, or when requested explicitly using the `sedentary-period` rollup type identifier.
+        "durationSum": "A String", # The total time user spent sedentary during the interval.
+      },
+      "startTime": "A String", # Start time of the window this value aggregates over
+      "steps": { # Represents the result of the rollup of the steps data type. # Returned by default when rolling up data points from the `steps` data type, or when requested explicitly using the `steps` rollup type identifier.
+        "countSum": "A String", # Total number of steps in the interval.
+      },
+      "timeInHeartRateZone": { # Represents the result of the rollup of the time in heart rate zone data type. # Returned by default when rolling up data points from the `time-in-heart-rate-zone` data type, or when requested explicitly using the `time-in-heart-rate-zone` rollup type identifier.
+        "timeInHeartRateZones": [ # List of time spent in each heart rate zone.
+          { # Represents the total time spent in a specific heart rate zone.
+            "duration": "A String", # The total time spent in the specified heart rate zone.
+            "heartRateZone": "A String", # The heart rate zone.
+          },
+        ],
+      },
+      "totalCalories": { # Represents the result of the rollup of the user's total calories. # Returned by default when rolling up data points from the `total-calories` data type, or when requested explicitly using the `total-calories` rollup type identifier.
+        "kcalSum": 3.14, # Sum of the total calories in kilocalories.
+      },
+      "weight": { # Represents the result of the rollup of the weight data type. # Returned by default when rolling up data points from the `weight` data type, or when requested explicitly using the `weight` rollup type identifier.
+        "weightGramsAvg": 3.14, # Average weight in grams.
+      },
+    },
+  ],
+}
+
+ +
+ rollUp_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/health_v4.users.dataTypes.html b/docs/dyn/health_v4.users.dataTypes.html new file mode 100644 index 0000000000..cfb78d766b --- /dev/null +++ b/docs/dyn/health_v4.users.dataTypes.html @@ -0,0 +1,91 @@ + + + +

Google Health API . users . dataTypes

+

Instance Methods

+

+ dataPoints() +

+

Returns the dataPoints Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/health_v4.users.html b/docs/dyn/health_v4.users.html new file mode 100644 index 0000000000..5274accf29 --- /dev/null +++ b/docs/dyn/health_v4.users.html @@ -0,0 +1,288 @@ + + + +

Google Health API . users

+

Instance Methods

+

+ dataTypes() +

+

Returns the dataTypes Resource.

+ +

+ close()

+

Close httplib2 connections.

+

+ getIdentity(name, x__xgafv=None)

+

Gets the user's identity. It includes the legacy Fitbit user ID and the Google user ID and it can be used by migrating clients to map identifiers between the two systems.

+

+ getProfile(name, x__xgafv=None)

+

Returns user Profile details.

+

+ getSettings(name, x__xgafv=None)

+

Returns user settings details.

+

+ updateProfile(name, body=None, updateMask=None, x__xgafv=None)

+

Updates the user's profile details.

+

+ updateSettings(name, body=None, updateMask=None, x__xgafv=None)

+

Updates the user's settings details.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ getIdentity(name, x__xgafv=None) +
Gets the user's identity. It includes the legacy Fitbit user ID and the Google user ID and it can be used by migrating clients to map identifiers between the two systems.
+
+Args:
+  name: string, Required. The resource name of the Identity. Format: `users/me/identity` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents details about the Google user's identity.
+  "healthUserId": "A String", # Output only. The Google User Identifier in the Google Health APIs. It matches the `{user}` resource ID segment in the resource name paths, e.g. `users/{user}/dataTypes/steps`. Valid values are strings of 1-63 characters, and valid characters are lowercase and uppercase letters, numbers, and hyphens.
+  "legacyUserId": "A String", # Output only. The legacy Fitbit User identifier. This is the Fitbit ID used in the legacy Fitbit APIs (v1-v3). It can be referenced by clients migrating from the legacy Fitbit APIs to map their existing identifiers to the new Google user ID. It **must not** be used for any other purpose. It is not of any use for new clients using only the Google Health APIs. Valid values are strings of 1-63 characters, and valid characters are lowercase and uppercase letters, numbers, and hyphens.
+  "name": "A String", # Identifier. The resource name of this Identity resource. Format: `users/me/identity`
+}
+
+ +
+ getProfile(name, x__xgafv=None) +
Returns user Profile details.
+
+Args:
+  name: string, Required. The name of the Profile. Format: `users/me/profile`. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Profile details.
+  "age": 42, # Optional. The age in years based on the user's birth date. Updates to this field are currently not supported.
+  "autoRunningStrideLengthMm": 42, # Output only. The automatically calculated running stride length, in millimeters. The user must consent to one of the following access scopes to access this field: - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly` - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness`
+  "autoWalkingStrideLengthMm": 42, # Output only. The automatically calculated walking stride length, in millimeters. The user must consent to one of the following access scopes to access this field: - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly` - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness`
+  "membershipStartDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. The date the user created their account. Updates to this field are currently not supported.
+    "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+    "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+    "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+  },
+  "name": "A String", # Identifier. The resource name of this Profile resource. Format: `users/{user}/profile` Example: `users/1234567890/profile` or `users/me/profile` The {user} ID is a system-generated Google Health API user ID, a string of 1-63 characters consisting of lowercase and uppercase letters, numbers, and hyphens. The literal `me` can also be used to refer to the authenticated user.
+  "userConfiguredRunningStrideLengthMm": 42, # Optional. The user's user configured running stride length, in millimeters. The user must consent to one of the following access scopes to access this field: - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly` - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness`
+  "userConfiguredWalkingStrideLengthMm": 42, # Optional. The user's user configured walking stride length, in millimeters. The user must consent to one of the following access scopes to access this field: - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly` - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness`
+}
+
+ +
+ getSettings(name, x__xgafv=None) +
Returns user settings details.
+
+Args:
+  name: string, Required. The name of the Settings. Format: `users/me/settings`. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Settings details.
+  "autoStrideEnabled": True or False, # Optional. True if the user's stride length is determined automatically. Updates to this field are currently not supported.
+  "distanceUnit": "A String", # Optional. The measurement unit defined in the user's account settings. Updates to this field are currently not supported.
+  "glucoseUnit": "A String", # Optional. The measurement unit defined in the user's account settings.
+  "heightUnit": "A String", # Optional. The measurement unit defined in the user's account settings.
+  "languageLocale": "A String", # Optional. The locale defined in the user's account settings. Updates to this field are currently not supported.
+  "name": "A String", # Identifier. The resource name of this Settings resource. Format: `users/{user}/settings` Example: `users/1234567890/settings` or `users/me/settings` The {user} ID is a system-generated Google Health API user ID, a string of 1-63 characters consisting of lowercase and uppercase letters, numbers, and hyphens. The literal `me` can also be used to refer to the authenticated user.
+  "strideLengthRunningType": "A String", # Optional. The stride length type defined in the user's account settings for running. Updates to this field are currently not supported.
+  "strideLengthWalkingType": "A String", # Optional. The stride length type defined in the user's account settings for walking. Updates to this field are currently not supported.
+  "swimUnit": "A String", # Optional. The measurement unit defined in the user's account settings.
+  "temperatureUnit": "A String", # Optional. The measurement unit defined in the user's account settings.
+  "timeZone": "A String", # Optional. The timezone defined in the user's account settings. This follows the IANA [Time Zone Database](https://www.iana.org/time-zones). Updates to this field are currently not supported.
+  "utcOffset": "A String", # Optional. The user's timezone offset relative to UTC. Updates to this field are currently not supported.
+  "waterUnit": "A String", # Optional. The measurement unit defined in the user's account settings.
+  "weightUnit": "A String", # Optional. The measurement unit defined in the user's account settings.
+}
+
+ +
+ updateProfile(name, body=None, updateMask=None, x__xgafv=None) +
Updates the user's profile details.
+
+Args:
+  name: string, Identifier. The resource name of this Profile resource. Format: `users/{user}/profile` Example: `users/1234567890/profile` or `users/me/profile` The {user} ID is a system-generated Google Health API user ID, a string of 1-63 characters consisting of lowercase and uppercase letters, numbers, and hyphens. The literal `me` can also be used to refer to the authenticated user. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Profile details.
+  "age": 42, # Optional. The age in years based on the user's birth date. Updates to this field are currently not supported.
+  "autoRunningStrideLengthMm": 42, # Output only. The automatically calculated running stride length, in millimeters. The user must consent to one of the following access scopes to access this field: - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly` - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness`
+  "autoWalkingStrideLengthMm": 42, # Output only. The automatically calculated walking stride length, in millimeters. The user must consent to one of the following access scopes to access this field: - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly` - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness`
+  "membershipStartDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. The date the user created their account. Updates to this field are currently not supported.
+    "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+    "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+    "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+  },
+  "name": "A String", # Identifier. The resource name of this Profile resource. Format: `users/{user}/profile` Example: `users/1234567890/profile` or `users/me/profile` The {user} ID is a system-generated Google Health API user ID, a string of 1-63 characters consisting of lowercase and uppercase letters, numbers, and hyphens. The literal `me` can also be used to refer to the authenticated user.
+  "userConfiguredRunningStrideLengthMm": 42, # Optional. The user's user configured running stride length, in millimeters. The user must consent to one of the following access scopes to access this field: - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly` - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness`
+  "userConfiguredWalkingStrideLengthMm": 42, # Optional. The user's user configured walking stride length, in millimeters. The user must consent to one of the following access scopes to access this field: - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly` - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness`
+}
+
+  updateMask: string, Optional. The list of fields to be updated.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Profile details.
+  "age": 42, # Optional. The age in years based on the user's birth date. Updates to this field are currently not supported.
+  "autoRunningStrideLengthMm": 42, # Output only. The automatically calculated running stride length, in millimeters. The user must consent to one of the following access scopes to access this field: - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly` - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness`
+  "autoWalkingStrideLengthMm": 42, # Output only. The automatically calculated walking stride length, in millimeters. The user must consent to one of the following access scopes to access this field: - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly` - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness`
+  "membershipStartDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. The date the user created their account. Updates to this field are currently not supported.
+    "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+    "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+    "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+  },
+  "name": "A String", # Identifier. The resource name of this Profile resource. Format: `users/{user}/profile` Example: `users/1234567890/profile` or `users/me/profile` The {user} ID is a system-generated Google Health API user ID, a string of 1-63 characters consisting of lowercase and uppercase letters, numbers, and hyphens. The literal `me` can also be used to refer to the authenticated user.
+  "userConfiguredRunningStrideLengthMm": 42, # Optional. The user's user configured running stride length, in millimeters. The user must consent to one of the following access scopes to access this field: - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly` - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness`
+  "userConfiguredWalkingStrideLengthMm": 42, # Optional. The user's user configured walking stride length, in millimeters. The user must consent to one of the following access scopes to access this field: - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly` - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness`
+}
+
+ +
+ updateSettings(name, body=None, updateMask=None, x__xgafv=None) +
Updates the user's settings details.
+
+Args:
+  name: string, Identifier. The resource name of this Settings resource. Format: `users/{user}/settings` Example: `users/1234567890/settings` or `users/me/settings` The {user} ID is a system-generated Google Health API user ID, a string of 1-63 characters consisting of lowercase and uppercase letters, numbers, and hyphens. The literal `me` can also be used to refer to the authenticated user. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Settings details.
+  "autoStrideEnabled": True or False, # Optional. True if the user's stride length is determined automatically. Updates to this field are currently not supported.
+  "distanceUnit": "A String", # Optional. The measurement unit defined in the user's account settings. Updates to this field are currently not supported.
+  "glucoseUnit": "A String", # Optional. The measurement unit defined in the user's account settings.
+  "heightUnit": "A String", # Optional. The measurement unit defined in the user's account settings.
+  "languageLocale": "A String", # Optional. The locale defined in the user's account settings. Updates to this field are currently not supported.
+  "name": "A String", # Identifier. The resource name of this Settings resource. Format: `users/{user}/settings` Example: `users/1234567890/settings` or `users/me/settings` The {user} ID is a system-generated Google Health API user ID, a string of 1-63 characters consisting of lowercase and uppercase letters, numbers, and hyphens. The literal `me` can also be used to refer to the authenticated user.
+  "strideLengthRunningType": "A String", # Optional. The stride length type defined in the user's account settings for running. Updates to this field are currently not supported.
+  "strideLengthWalkingType": "A String", # Optional. The stride length type defined in the user's account settings for walking. Updates to this field are currently not supported.
+  "swimUnit": "A String", # Optional. The measurement unit defined in the user's account settings.
+  "temperatureUnit": "A String", # Optional. The measurement unit defined in the user's account settings.
+  "timeZone": "A String", # Optional. The timezone defined in the user's account settings. This follows the IANA [Time Zone Database](https://www.iana.org/time-zones). Updates to this field are currently not supported.
+  "utcOffset": "A String", # Optional. The user's timezone offset relative to UTC. Updates to this field are currently not supported.
+  "waterUnit": "A String", # Optional. The measurement unit defined in the user's account settings.
+  "weightUnit": "A String", # Optional. The measurement unit defined in the user's account settings.
+}
+
+  updateMask: string, Optional. The list of fields to be updated.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Settings details.
+  "autoStrideEnabled": True or False, # Optional. True if the user's stride length is determined automatically. Updates to this field are currently not supported.
+  "distanceUnit": "A String", # Optional. The measurement unit defined in the user's account settings. Updates to this field are currently not supported.
+  "glucoseUnit": "A String", # Optional. The measurement unit defined in the user's account settings.
+  "heightUnit": "A String", # Optional. The measurement unit defined in the user's account settings.
+  "languageLocale": "A String", # Optional. The locale defined in the user's account settings. Updates to this field are currently not supported.
+  "name": "A String", # Identifier. The resource name of this Settings resource. Format: `users/{user}/settings` Example: `users/1234567890/settings` or `users/me/settings` The {user} ID is a system-generated Google Health API user ID, a string of 1-63 characters consisting of lowercase and uppercase letters, numbers, and hyphens. The literal `me` can also be used to refer to the authenticated user.
+  "strideLengthRunningType": "A String", # Optional. The stride length type defined in the user's account settings for running. Updates to this field are currently not supported.
+  "strideLengthWalkingType": "A String", # Optional. The stride length type defined in the user's account settings for walking. Updates to this field are currently not supported.
+  "swimUnit": "A String", # Optional. The measurement unit defined in the user's account settings.
+  "temperatureUnit": "A String", # Optional. The measurement unit defined in the user's account settings.
+  "timeZone": "A String", # Optional. The timezone defined in the user's account settings. This follows the IANA [Time Zone Database](https://www.iana.org/time-zones). Updates to this field are currently not supported.
+  "utcOffset": "A String", # Optional. The user's timezone offset relative to UTC. Updates to this field are currently not supported.
+  "waterUnit": "A String", # Optional. The measurement unit defined in the user's account settings.
+  "weightUnit": "A String", # Optional. The measurement unit defined in the user's account settings.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/healthcare_v1.projects.locations.html b/docs/dyn/healthcare_v1.projects.locations.html index 40fadfc7fd..be13e7c3ed 100644 --- a/docs/dyn/healthcare_v1.projects.locations.html +++ b/docs/dyn/healthcare_v1.projects.locations.html @@ -92,7 +92,7 @@

Instance Methods

Gets information about a location.

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

-

Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.

+

Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.

list_next()

Retrieves the next page of results.

@@ -131,7 +131,7 @@

Method Details

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
+  
Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
diff --git a/docs/dyn/healthcare_v1beta1.projects.locations.html b/docs/dyn/healthcare_v1beta1.projects.locations.html
index 2ad4b27677..b97a04cf92 100644
--- a/docs/dyn/healthcare_v1beta1.projects.locations.html
+++ b/docs/dyn/healthcare_v1beta1.projects.locations.html
@@ -92,7 +92,7 @@ 

Instance Methods

Gets information about a location.

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

-

Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.

+

Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.

list_next()

Retrieves the next page of results.

@@ -131,7 +131,7 @@

Method Details

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
+  
Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
diff --git a/docs/dyn/hypercomputecluster_v1.projects.locations.html b/docs/dyn/hypercomputecluster_v1.projects.locations.html
index 1ad4790bf0..e69ed09ef5 100644
--- a/docs/dyn/hypercomputecluster_v1.projects.locations.html
+++ b/docs/dyn/hypercomputecluster_v1.projects.locations.html
@@ -92,7 +92,7 @@ 

Instance Methods

Gets information about a location.

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

-

Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.

+

Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.

list_next()

Retrieves the next page of results.

@@ -131,7 +131,7 @@

Method Details

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
+  
Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
diff --git a/docs/dyn/iamcredentials_v1.locations.workforcePools.html b/docs/dyn/iamcredentials_v1.locations.workforcePools.html
index 8d01158890..1106219bb2 100644
--- a/docs/dyn/iamcredentials_v1.locations.workforcePools.html
+++ b/docs/dyn/iamcredentials_v1.locations.workforcePools.html
@@ -91,7 +91,7 @@ 

Method Details

Returns the trust boundary info for a given workforce pool.
 
 Args:
-  name: string, Required. Resource name of workforce pool. (required)
+  name: string, Required. Resource name of workforce pool. Format: `locations/global/workforcePools/{pool_id}` (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
diff --git a/docs/dyn/iamcredentials_v1.projects.locations.workloadIdentityPools.html b/docs/dyn/iamcredentials_v1.projects.locations.workloadIdentityPools.html
index daeae9a911..e05838a6ef 100644
--- a/docs/dyn/iamcredentials_v1.projects.locations.workloadIdentityPools.html
+++ b/docs/dyn/iamcredentials_v1.projects.locations.workloadIdentityPools.html
@@ -91,7 +91,7 @@ 

Method Details

Returns the trust boundary info for a given workload identity pool.
 
 Args:
-  name: string, Required. Resource name of workload identity pool. (required)
+  name: string, Required. Resource name of workload identity pool. Format: `projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}` (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
diff --git a/docs/dyn/iamcredentials_v1.projects.serviceAccounts.html b/docs/dyn/iamcredentials_v1.projects.serviceAccounts.html
index ced1bad9f1..42b3031c56 100644
--- a/docs/dyn/iamcredentials_v1.projects.serviceAccounts.html
+++ b/docs/dyn/iamcredentials_v1.projects.serviceAccounts.html
@@ -167,7 +167,7 @@ 

Method Details

Returns the trust boundary info for a given service account.
 
 Args:
-  name: string, Required. Resource name of service account. (required)
+  name: string, Required. Resource name of service account. Format: `projects/-/serviceAccounts/{service_account_email}` (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
diff --git a/docs/dyn/ids_v1.projects.locations.html b/docs/dyn/ids_v1.projects.locations.html
index 8678400da8..83f90da8a7 100644
--- a/docs/dyn/ids_v1.projects.locations.html
+++ b/docs/dyn/ids_v1.projects.locations.html
@@ -92,7 +92,7 @@ 

Instance Methods

Gets information about a location.

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

-

Lists information about the supported locations for this service.

+

Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.

list_next()

Retrieves the next page of results.

@@ -131,7 +131,7 @@

Method Details

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists information about the supported locations for this service.
+  
Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
diff --git a/docs/dyn/index.md b/docs/dyn/index.md
index a9d37f654d..1ea4fc0d39 100644
--- a/docs/dyn/index.md
+++ b/docs/dyn/index.md
@@ -743,6 +743,10 @@
 * [v1](http://googleapis.github.io/google-api-python-client/docs/dyn/groupssettings_v1.html)
 
 
+## health
+* [v4](http://googleapis.github.io/google-api-python-client/docs/dyn/health_v4.html)
+
+
 ## healthcare
 * [v1](http://googleapis.github.io/google-api-python-client/docs/dyn/healthcare_v1.html)
 * [v1beta1](http://googleapis.github.io/google-api-python-client/docs/dyn/healthcare_v1beta1.html)
diff --git a/docs/dyn/logging_v2.billingAccounts.locations.html b/docs/dyn/logging_v2.billingAccounts.locations.html
index 15fc33cca9..a6447fa00f 100644
--- a/docs/dyn/logging_v2.billingAccounts.locations.html
+++ b/docs/dyn/logging_v2.billingAccounts.locations.html
@@ -102,7 +102,7 @@ 

Instance Methods

Gets information about a location.

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

-

Lists information about the supported locations for this service. This method can be called in two ways: List all public locations: Use the path GET /v1/locations. List project-visible locations: Use the path GET /v1/projects/{project_id}/locations. This may include public locations as well as private or other locations specifically visible to the project.

+

Lists information about the supported locations for this service.This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: Global locations: If name is empty, the method lists the public locations available to all projects. Project-specific locations: If name follows the format projects/{project}, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project.For gRPC and client library implementations, the resource name is passed as the name field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.

list_next()

Retrieves the next page of results.

@@ -141,7 +141,7 @@

Method Details

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists information about the supported locations for this service. This method can be called in two ways: List all public locations: Use the path GET /v1/locations. List project-visible locations: Use the path GET /v1/projects/{project_id}/locations. This may include public locations as well as private or other locations specifically visible to the project.
+  
Lists information about the supported locations for this service.This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: Global locations: If name is empty, the method lists the public locations available to all projects. Project-specific locations: If name follows the format projects/{project}, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project.For gRPC and client library implementations, the resource name is passed as the name field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
diff --git a/docs/dyn/logging_v2.entries.html b/docs/dyn/logging_v2.entries.html
index 7e7c112a3b..308f80c1d7 100644
--- a/docs/dyn/logging_v2.entries.html
+++ b/docs/dyn/logging_v2.entries.html
@@ -268,6 +268,9 @@ 

Method Details

"last": True or False, # Optional. Set this to True if this is the last log entry in the operation. "producer": "A String", # Optional. An arbitrary producer identifier. The combination of id and producer must be globally unique. Examples for producer: "MyDivision.MyBigCompany.com", "github.com/MyProject/MyApplication". }, + "otel": { # Optional. The structured OpenTelemetry protocol payload. Contains the OpenTelemetry Resource, Instrumentation Scope, and Entities attributes for this log as they are defined in the OTLP specification, and any other fields that do not have a direct analog in the LogEntry. See https://opentelemetry.io/docs/specs/otel/logs/data-model/ + "a_key": "", # Properties of the object. + }, "protoPayload": { # The log entry payload, represented as a protocol buffer. Some Google Cloud Platform services use this field for their log entry payloads.The following protocol buffer types are supported; user-defined types are not supported:"type.googleapis.com/google.cloud.audit.AuditLog" "type.googleapis.com/google.appengine.logging.v1.RequestLog" "a_key": "", # Properties of the object. Contains field @type with type URL. }, @@ -436,6 +439,9 @@

Method Details

"last": True or False, # Optional. Set this to True if this is the last log entry in the operation. "producer": "A String", # Optional. An arbitrary producer identifier. The combination of id and producer must be globally unique. Examples for producer: "MyDivision.MyBigCompany.com", "github.com/MyProject/MyApplication". }, + "otel": { # Optional. The structured OpenTelemetry protocol payload. Contains the OpenTelemetry Resource, Instrumentation Scope, and Entities attributes for this log as they are defined in the OTLP specification, and any other fields that do not have a direct analog in the LogEntry. See https://opentelemetry.io/docs/specs/otel/logs/data-model/ + "a_key": "", # Properties of the object. + }, "protoPayload": { # The log entry payload, represented as a protocol buffer. Some Google Cloud Platform services use this field for their log entry payloads.The following protocol buffer types are supported; user-defined types are not supported:"type.googleapis.com/google.cloud.audit.AuditLog" "type.googleapis.com/google.appengine.logging.v1.RequestLog" "a_key": "", # Properties of the object. Contains field @type with type URL. }, @@ -580,6 +586,9 @@

Method Details

"last": True or False, # Optional. Set this to True if this is the last log entry in the operation. "producer": "A String", # Optional. An arbitrary producer identifier. The combination of id and producer must be globally unique. Examples for producer: "MyDivision.MyBigCompany.com", "github.com/MyProject/MyApplication". }, + "otel": { # Optional. The structured OpenTelemetry protocol payload. Contains the OpenTelemetry Resource, Instrumentation Scope, and Entities attributes for this log as they are defined in the OTLP specification, and any other fields that do not have a direct analog in the LogEntry. See https://opentelemetry.io/docs/specs/otel/logs/data-model/ + "a_key": "", # Properties of the object. + }, "protoPayload": { # The log entry payload, represented as a protocol buffer. Some Google Cloud Platform services use this field for their log entry payloads.The following protocol buffer types are supported; user-defined types are not supported:"type.googleapis.com/google.cloud.audit.AuditLog" "type.googleapis.com/google.appengine.logging.v1.RequestLog" "a_key": "", # Properties of the object. Contains field @type with type URL. }, diff --git a/docs/dyn/logging_v2.folders.locations.html b/docs/dyn/logging_v2.folders.locations.html index e380057b4b..5912719270 100644 --- a/docs/dyn/logging_v2.folders.locations.html +++ b/docs/dyn/logging_v2.folders.locations.html @@ -107,7 +107,7 @@

Instance Methods

Gets information about a location.

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

-

Lists information about the supported locations for this service. This method can be called in two ways: List all public locations: Use the path GET /v1/locations. List project-visible locations: Use the path GET /v1/projects/{project_id}/locations. This may include public locations as well as private or other locations specifically visible to the project.

+

Lists information about the supported locations for this service.This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: Global locations: If name is empty, the method lists the public locations available to all projects. Project-specific locations: If name follows the format projects/{project}, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project.For gRPC and client library implementations, the resource name is passed as the name field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.

list_next()

Retrieves the next page of results.

@@ -146,7 +146,7 @@

Method Details

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists information about the supported locations for this service. This method can be called in two ways: List all public locations: Use the path GET /v1/locations. List project-visible locations: Use the path GET /v1/projects/{project_id}/locations. This may include public locations as well as private or other locations specifically visible to the project.
+  
Lists information about the supported locations for this service.This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: Global locations: If name is empty, the method lists the public locations available to all projects. Project-specific locations: If name follows the format projects/{project}, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project.For gRPC and client library implementations, the resource name is passed as the name field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
diff --git a/docs/dyn/logging_v2.locations.html b/docs/dyn/logging_v2.locations.html
index 6d2e368e80..cb4421e7b5 100644
--- a/docs/dyn/logging_v2.locations.html
+++ b/docs/dyn/logging_v2.locations.html
@@ -92,7 +92,7 @@ 

Instance Methods

Gets information about a location.

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

-

Lists information about the supported locations for this service. This method can be called in two ways: List all public locations: Use the path GET /v1/locations. List project-visible locations: Use the path GET /v1/projects/{project_id}/locations. This may include public locations as well as private or other locations specifically visible to the project.

+

Lists information about the supported locations for this service.This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: Global locations: If name is empty, the method lists the public locations available to all projects. Project-specific locations: If name follows the format projects/{project}, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project.For gRPC and client library implementations, the resource name is passed as the name field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.

list_next()

Retrieves the next page of results.

@@ -131,7 +131,7 @@

Method Details

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists information about the supported locations for this service. This method can be called in two ways: List all public locations: Use the path GET /v1/locations. List project-visible locations: Use the path GET /v1/projects/{project_id}/locations. This may include public locations as well as private or other locations specifically visible to the project.
+  
Lists information about the supported locations for this service.This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: Global locations: If name is empty, the method lists the public locations available to all projects. Project-specific locations: If name follows the format projects/{project}, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project.For gRPC and client library implementations, the resource name is passed as the name field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
diff --git a/docs/dyn/logging_v2.organizations.locations.html b/docs/dyn/logging_v2.organizations.locations.html
index 10d468f802..6a49dd8795 100644
--- a/docs/dyn/logging_v2.organizations.locations.html
+++ b/docs/dyn/logging_v2.organizations.locations.html
@@ -107,7 +107,7 @@ 

Instance Methods

Gets information about a location.

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

-

Lists information about the supported locations for this service. This method can be called in two ways: List all public locations: Use the path GET /v1/locations. List project-visible locations: Use the path GET /v1/projects/{project_id}/locations. This may include public locations as well as private or other locations specifically visible to the project.

+

Lists information about the supported locations for this service.This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: Global locations: If name is empty, the method lists the public locations available to all projects. Project-specific locations: If name follows the format projects/{project}, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project.For gRPC and client library implementations, the resource name is passed as the name field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.

list_next()

Retrieves the next page of results.

@@ -146,7 +146,7 @@

Method Details

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists information about the supported locations for this service. This method can be called in two ways: List all public locations: Use the path GET /v1/locations. List project-visible locations: Use the path GET /v1/projects/{project_id}/locations. This may include public locations as well as private or other locations specifically visible to the project.
+  
Lists information about the supported locations for this service.This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: Global locations: If name is empty, the method lists the public locations available to all projects. Project-specific locations: If name follows the format projects/{project}, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project.For gRPC and client library implementations, the resource name is passed as the name field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
diff --git a/docs/dyn/logging_v2.projects.locations.html b/docs/dyn/logging_v2.projects.locations.html
index d623c0e745..1f43b9c7b0 100644
--- a/docs/dyn/logging_v2.projects.locations.html
+++ b/docs/dyn/logging_v2.projects.locations.html
@@ -107,7 +107,7 @@ 

Instance Methods

Gets information about a location.

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

-

Lists information about the supported locations for this service. This method can be called in two ways: List all public locations: Use the path GET /v1/locations. List project-visible locations: Use the path GET /v1/projects/{project_id}/locations. This may include public locations as well as private or other locations specifically visible to the project.

+

Lists information about the supported locations for this service.This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: Global locations: If name is empty, the method lists the public locations available to all projects. Project-specific locations: If name follows the format projects/{project}, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project.For gRPC and client library implementations, the resource name is passed as the name field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.

list_next()

Retrieves the next page of results.

@@ -146,7 +146,7 @@

Method Details

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists information about the supported locations for this service. This method can be called in two ways: List all public locations: Use the path GET /v1/locations. List project-visible locations: Use the path GET /v1/projects/{project_id}/locations. This may include public locations as well as private or other locations specifically visible to the project.
+  
Lists information about the supported locations for this service.This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: Global locations: If name is empty, the method lists the public locations available to all projects. Project-specific locations: If name follows the format projects/{project}, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project.For gRPC and client library implementations, the resource name is passed as the name field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
diff --git a/docs/dyn/looker_v1.projects.locations.html b/docs/dyn/looker_v1.projects.locations.html
index 24ab143355..e2b07ec6ec 100644
--- a/docs/dyn/looker_v1.projects.locations.html
+++ b/docs/dyn/looker_v1.projects.locations.html
@@ -92,7 +92,7 @@ 

Instance Methods

Gets information about a location.

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

-

Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.

+

Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.

list_next()

Retrieves the next page of results.

@@ -131,7 +131,7 @@

Method Details

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
+  
Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
diff --git a/docs/dyn/looker_v1.projects.locations.instances.html b/docs/dyn/looker_v1.projects.locations.instances.html
index 3f07e3821d..1e8950737d 100644
--- a/docs/dyn/looker_v1.projects.locations.instances.html
+++ b/docs/dyn/looker_v1.projects.locations.instances.html
@@ -133,6 +133,7 @@ 

Method Details

"A String", ], }, + "catalogIntegrationOptOut": True or False, # Optional. Indicates whether catalog integration is disabled for the Looker instance. "classType": "A String", # Optional. Storage class of the instance. "consumerNetwork": "A String", # Network name in the consumer project. Format: `projects/{project}/global/networks/{network}`. Note that the consumer network may be in a different GCP project than the consumer project that is hosting the Looker Instance. "controlledEgressConfig": { # Controlled egress configuration. # Optional. Controlled egress configuration. @@ -176,6 +177,16 @@

Method Details

}, "fipsEnabled": True or False, # Optional. Whether FIPS is enabled on the Looker instance. "geminiEnabled": True or False, # Optional. Whether Gemini feature is enabled on the Looker instance or not. + "ingressIpAllowlistConfig": { # Ingress IP allowlist configuration. # Optional. Ingress IP allowlist configuration for the Looker instance. + "allowlistRules": [ # Optional. List of IP range rules to allow ingress traffic. + { # Ingress IP allowlist rule. + "description": "A String", # Optional. Description for the IP range. + "ipRange": "A String", # Optional. The IP range to allow ingress traffic from. + }, + ], + "enabled": True or False, # Optional. Whether ingress IP allowlist functionality is enabled on the Looker instance. + "googleServicesEnabled": True or False, # Optional. Whether google service connections are enabled for the instance. + }, "ingressPrivateIp": "A String", # Output only. Private Ingress IP (IPv4). "ingressPublicIp": "A String", # Output only. Public Ingress IP (IPv4). "lastDenyMaintenancePeriod": { # Specifies the maintenance denial period. # Output only. Last computed maintenance denial period for this instance. @@ -392,6 +403,7 @@

Method Details

"A String", ], }, + "catalogIntegrationOptOut": True or False, # Optional. Indicates whether catalog integration is disabled for the Looker instance. "classType": "A String", # Optional. Storage class of the instance. "consumerNetwork": "A String", # Network name in the consumer project. Format: `projects/{project}/global/networks/{network}`. Note that the consumer network may be in a different GCP project than the consumer project that is hosting the Looker Instance. "controlledEgressConfig": { # Controlled egress configuration. # Optional. Controlled egress configuration. @@ -435,6 +447,16 @@

Method Details

}, "fipsEnabled": True or False, # Optional. Whether FIPS is enabled on the Looker instance. "geminiEnabled": True or False, # Optional. Whether Gemini feature is enabled on the Looker instance or not. + "ingressIpAllowlistConfig": { # Ingress IP allowlist configuration. # Optional. Ingress IP allowlist configuration for the Looker instance. + "allowlistRules": [ # Optional. List of IP range rules to allow ingress traffic. + { # Ingress IP allowlist rule. + "description": "A String", # Optional. Description for the IP range. + "ipRange": "A String", # Optional. The IP range to allow ingress traffic from. + }, + ], + "enabled": True or False, # Optional. Whether ingress IP allowlist functionality is enabled on the Looker instance. + "googleServicesEnabled": True or False, # Optional. Whether google service connections are enabled for the instance. + }, "ingressPrivateIp": "A String", # Output only. Private Ingress IP (IPv4). "ingressPublicIp": "A String", # Output only. Public Ingress IP (IPv4). "lastDenyMaintenancePeriod": { # Specifies the maintenance denial period. # Output only. Last computed maintenance denial period for this instance. @@ -587,6 +609,7 @@

Method Details

"A String", ], }, + "catalogIntegrationOptOut": True or False, # Optional. Indicates whether catalog integration is disabled for the Looker instance. "classType": "A String", # Optional. Storage class of the instance. "consumerNetwork": "A String", # Network name in the consumer project. Format: `projects/{project}/global/networks/{network}`. Note that the consumer network may be in a different GCP project than the consumer project that is hosting the Looker Instance. "controlledEgressConfig": { # Controlled egress configuration. # Optional. Controlled egress configuration. @@ -630,6 +653,16 @@

Method Details

}, "fipsEnabled": True or False, # Optional. Whether FIPS is enabled on the Looker instance. "geminiEnabled": True or False, # Optional. Whether Gemini feature is enabled on the Looker instance or not. + "ingressIpAllowlistConfig": { # Ingress IP allowlist configuration. # Optional. Ingress IP allowlist configuration for the Looker instance. + "allowlistRules": [ # Optional. List of IP range rules to allow ingress traffic. + { # Ingress IP allowlist rule. + "description": "A String", # Optional. Description for the IP range. + "ipRange": "A String", # Optional. The IP range to allow ingress traffic from. + }, + ], + "enabled": True or False, # Optional. Whether ingress IP allowlist functionality is enabled on the Looker instance. + "googleServicesEnabled": True or False, # Optional. Whether google service connections are enabled for the instance. + }, "ingressPrivateIp": "A String", # Output only. Private Ingress IP (IPv4). "ingressPublicIp": "A String", # Output only. Public Ingress IP (IPv4). "lastDenyMaintenancePeriod": { # Specifies the maintenance denial period. # Output only. Last computed maintenance denial period for this instance. @@ -751,6 +784,7 @@

Method Details

"A String", ], }, + "catalogIntegrationOptOut": True or False, # Optional. Indicates whether catalog integration is disabled for the Looker instance. "classType": "A String", # Optional. Storage class of the instance. "consumerNetwork": "A String", # Network name in the consumer project. Format: `projects/{project}/global/networks/{network}`. Note that the consumer network may be in a different GCP project than the consumer project that is hosting the Looker Instance. "controlledEgressConfig": { # Controlled egress configuration. # Optional. Controlled egress configuration. @@ -794,6 +828,16 @@

Method Details

}, "fipsEnabled": True or False, # Optional. Whether FIPS is enabled on the Looker instance. "geminiEnabled": True or False, # Optional. Whether Gemini feature is enabled on the Looker instance or not. + "ingressIpAllowlistConfig": { # Ingress IP allowlist configuration. # Optional. Ingress IP allowlist configuration for the Looker instance. + "allowlistRules": [ # Optional. List of IP range rules to allow ingress traffic. + { # Ingress IP allowlist rule. + "description": "A String", # Optional. Description for the IP range. + "ipRange": "A String", # Optional. The IP range to allow ingress traffic from. + }, + ], + "enabled": True or False, # Optional. Whether ingress IP allowlist functionality is enabled on the Looker instance. + "googleServicesEnabled": True or False, # Optional. Whether google service connections are enabled for the instance. + }, "ingressPrivateIp": "A String", # Output only. Private Ingress IP (IPv4). "ingressPublicIp": "A String", # Output only. Public Ingress IP (IPv4). "lastDenyMaintenancePeriod": { # Specifies the maintenance denial period. # Output only. Last computed maintenance denial period for this instance. diff --git a/docs/dyn/meet_v2.spaces.html b/docs/dyn/meet_v2.spaces.html index 479ebff591..2757e5219d 100644 --- a/docs/dyn/meet_v2.spaces.html +++ b/docs/dyn/meet_v2.spaces.html @@ -130,9 +130,23 @@

Method Details

"reactionRestriction": "A String", # Defines who has permission to send reactions in the meeting space. }, }, + "gatewaySipAccess": [ # Output only. The SIP based access methods that can be used to join the conference. Can be empty. + { # Details how to join the conference via a SIP gateway. + "sipAccessCode": "A String", # Permanent numeric code for manual entry on specially configured devices. + "uri": "A String", # The SIP URI the conference can be reached through. The string is on one of the formats: "sip:@" "sips:@" where currently is the 13-digit universal pin, and is a valid address to be resolved using a DNS SRV lookup, or a dotted quad. + }, + ], "meetingCode": "A String", # Output only. Type friendly unique string used to join the meeting. Format: `[a-z]+-[a-z]+-[a-z]+`. For example, `abc-mnop-xyz`. The maximum length is 128 characters. Can only be used as an alias of the space name to get the space. "meetingUri": "A String", # Output only. URI used to join meetings consisting of `https://meet.google.com/` followed by the `meeting_code`. For example, `https://meet.google.com/abc-mnop-xyz`. "name": "A String", # Immutable. Resource name of the space. Format: `spaces/{space}`. `{space}` is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`. For more information, see [How Meet identifies a meeting space](https://developers.google.com/workspace/meet/api/guides/meeting-spaces#identify-meeting-space). + "phoneAccess": [ # Output only. All regional phone access methods for this meeting space. Can be empty. + { # Phone access contains information required to dial into a conference using a regional phone number and a PIN that is specific to that phone number. + "languageCode": "A String", # The BCP 47/LDML language code for the language associated with this phone access. To be parsed by the i18n LanguageCode utility. Examples: "es-419" for Latin American Spanish, "fr-CA" for Canadian French. + "phoneNumber": "A String", # The phone number to dial for this meeting space in E.164 format. Full phone number with a leading '+' character. + "pin": "A String", # The PIN that users must enter after dialing the given number. The PIN consists of only decimal digits and the length may vary. + "regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. To be parsed by the i18n RegionCode utility. Example: "SE" for Sweden. + }, + ], } x__xgafv: string, V1 error format. @@ -170,9 +184,23 @@

Method Details

"reactionRestriction": "A String", # Defines who has permission to send reactions in the meeting space. }, }, + "gatewaySipAccess": [ # Output only. The SIP based access methods that can be used to join the conference. Can be empty. + { # Details how to join the conference via a SIP gateway. + "sipAccessCode": "A String", # Permanent numeric code for manual entry on specially configured devices. + "uri": "A String", # The SIP URI the conference can be reached through. The string is on one of the formats: "sip:@" "sips:@" where currently is the 13-digit universal pin, and is a valid address to be resolved using a DNS SRV lookup, or a dotted quad. + }, + ], "meetingCode": "A String", # Output only. Type friendly unique string used to join the meeting. Format: `[a-z]+-[a-z]+-[a-z]+`. For example, `abc-mnop-xyz`. The maximum length is 128 characters. Can only be used as an alias of the space name to get the space. "meetingUri": "A String", # Output only. URI used to join meetings consisting of `https://meet.google.com/` followed by the `meeting_code`. For example, `https://meet.google.com/abc-mnop-xyz`. "name": "A String", # Immutable. Resource name of the space. Format: `spaces/{space}`. `{space}` is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`. For more information, see [How Meet identifies a meeting space](https://developers.google.com/workspace/meet/api/guides/meeting-spaces#identify-meeting-space). + "phoneAccess": [ # Output only. All regional phone access methods for this meeting space. Can be empty. + { # Phone access contains information required to dial into a conference using a regional phone number and a PIN that is specific to that phone number. + "languageCode": "A String", # The BCP 47/LDML language code for the language associated with this phone access. To be parsed by the i18n LanguageCode utility. Examples: "es-419" for Latin American Spanish, "fr-CA" for Canadian French. + "phoneNumber": "A String", # The phone number to dial for this meeting space in E.164 format. Full phone number with a leading '+' character. + "pin": "A String", # The PIN that users must enter after dialing the given number. The PIN consists of only decimal digits and the length may vary. + "regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. To be parsed by the i18n RegionCode utility. Example: "SE" for Sweden. + }, + ], }
@@ -241,9 +269,23 @@

Method Details

"reactionRestriction": "A String", # Defines who has permission to send reactions in the meeting space. }, }, + "gatewaySipAccess": [ # Output only. The SIP based access methods that can be used to join the conference. Can be empty. + { # Details how to join the conference via a SIP gateway. + "sipAccessCode": "A String", # Permanent numeric code for manual entry on specially configured devices. + "uri": "A String", # The SIP URI the conference can be reached through. The string is on one of the formats: "sip:@" "sips:@" where currently is the 13-digit universal pin, and is a valid address to be resolved using a DNS SRV lookup, or a dotted quad. + }, + ], "meetingCode": "A String", # Output only. Type friendly unique string used to join the meeting. Format: `[a-z]+-[a-z]+-[a-z]+`. For example, `abc-mnop-xyz`. The maximum length is 128 characters. Can only be used as an alias of the space name to get the space. "meetingUri": "A String", # Output only. URI used to join meetings consisting of `https://meet.google.com/` followed by the `meeting_code`. For example, `https://meet.google.com/abc-mnop-xyz`. "name": "A String", # Immutable. Resource name of the space. Format: `spaces/{space}`. `{space}` is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`. For more information, see [How Meet identifies a meeting space](https://developers.google.com/workspace/meet/api/guides/meeting-spaces#identify-meeting-space). + "phoneAccess": [ # Output only. All regional phone access methods for this meeting space. Can be empty. + { # Phone access contains information required to dial into a conference using a regional phone number and a PIN that is specific to that phone number. + "languageCode": "A String", # The BCP 47/LDML language code for the language associated with this phone access. To be parsed by the i18n LanguageCode utility. Examples: "es-419" for Latin American Spanish, "fr-CA" for Canadian French. + "phoneNumber": "A String", # The phone number to dial for this meeting space in E.164 format. Full phone number with a leading '+' character. + "pin": "A String", # The PIN that users must enter after dialing the given number. The PIN consists of only decimal digits and the length may vary. + "regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. To be parsed by the i18n RegionCode utility. Example: "SE" for Sweden. + }, + ], }
@@ -283,9 +325,23 @@

Method Details

"reactionRestriction": "A String", # Defines who has permission to send reactions in the meeting space. }, }, + "gatewaySipAccess": [ # Output only. The SIP based access methods that can be used to join the conference. Can be empty. + { # Details how to join the conference via a SIP gateway. + "sipAccessCode": "A String", # Permanent numeric code for manual entry on specially configured devices. + "uri": "A String", # The SIP URI the conference can be reached through. The string is on one of the formats: "sip:@" "sips:@" where currently is the 13-digit universal pin, and is a valid address to be resolved using a DNS SRV lookup, or a dotted quad. + }, + ], "meetingCode": "A String", # Output only. Type friendly unique string used to join the meeting. Format: `[a-z]+-[a-z]+-[a-z]+`. For example, `abc-mnop-xyz`. The maximum length is 128 characters. Can only be used as an alias of the space name to get the space. "meetingUri": "A String", # Output only. URI used to join meetings consisting of `https://meet.google.com/` followed by the `meeting_code`. For example, `https://meet.google.com/abc-mnop-xyz`. "name": "A String", # Immutable. Resource name of the space. Format: `spaces/{space}`. `{space}` is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`. For more information, see [How Meet identifies a meeting space](https://developers.google.com/workspace/meet/api/guides/meeting-spaces#identify-meeting-space). + "phoneAccess": [ # Output only. All regional phone access methods for this meeting space. Can be empty. + { # Phone access contains information required to dial into a conference using a regional phone number and a PIN that is specific to that phone number. + "languageCode": "A String", # The BCP 47/LDML language code for the language associated with this phone access. To be parsed by the i18n LanguageCode utility. Examples: "es-419" for Latin American Spanish, "fr-CA" for Canadian French. + "phoneNumber": "A String", # The phone number to dial for this meeting space in E.164 format. Full phone number with a leading '+' character. + "pin": "A String", # The PIN that users must enter after dialing the given number. The PIN consists of only decimal digits and the length may vary. + "regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. To be parsed by the i18n RegionCode utility. Example: "SE" for Sweden. + }, + ], } updateMask: string, Optional. Field mask used to specify the fields to be updated in the space. If update_mask isn't provided(not set, set with empty paths, or only has "" as paths), it defaults to update all fields provided with values in the request. Using "*" as update_mask will update all fields, including deleting fields not set in the request. @@ -324,9 +380,23 @@

Method Details

"reactionRestriction": "A String", # Defines who has permission to send reactions in the meeting space. }, }, + "gatewaySipAccess": [ # Output only. The SIP based access methods that can be used to join the conference. Can be empty. + { # Details how to join the conference via a SIP gateway. + "sipAccessCode": "A String", # Permanent numeric code for manual entry on specially configured devices. + "uri": "A String", # The SIP URI the conference can be reached through. The string is on one of the formats: "sip:@" "sips:@" where currently is the 13-digit universal pin, and is a valid address to be resolved using a DNS SRV lookup, or a dotted quad. + }, + ], "meetingCode": "A String", # Output only. Type friendly unique string used to join the meeting. Format: `[a-z]+-[a-z]+-[a-z]+`. For example, `abc-mnop-xyz`. The maximum length is 128 characters. Can only be used as an alias of the space name to get the space. "meetingUri": "A String", # Output only. URI used to join meetings consisting of `https://meet.google.com/` followed by the `meeting_code`. For example, `https://meet.google.com/abc-mnop-xyz`. "name": "A String", # Immutable. Resource name of the space. Format: `spaces/{space}`. `{space}` is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`. For more information, see [How Meet identifies a meeting space](https://developers.google.com/workspace/meet/api/guides/meeting-spaces#identify-meeting-space). + "phoneAccess": [ # Output only. All regional phone access methods for this meeting space. Can be empty. + { # Phone access contains information required to dial into a conference using a regional phone number and a PIN that is specific to that phone number. + "languageCode": "A String", # The BCP 47/LDML language code for the language associated with this phone access. To be parsed by the i18n LanguageCode utility. Examples: "es-419" for Latin American Spanish, "fr-CA" for Canadian French. + "phoneNumber": "A String", # The phone number to dial for this meeting space in E.164 format. Full phone number with a leading '+' character. + "pin": "A String", # The PIN that users must enter after dialing the given number. The PIN consists of only decimal digits and the length may vary. + "regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. To be parsed by the i18n RegionCode utility. Example: "SE" for Sweden. + }, + ], }
diff --git a/docs/dyn/merchantapi_inventories_v1.accounts.products.localInventories.html b/docs/dyn/merchantapi_inventories_v1.accounts.products.localInventories.html index f7b8c1e4d4..0e64deb65f 100644 --- a/docs/dyn/merchantapi_inventories_v1.accounts.products.localInventories.html +++ b/docs/dyn/merchantapi_inventories_v1.accounts.products.localInventories.html @@ -100,7 +100,7 @@

Method Details

Deletes the specified `LocalInventory` from the given product in your merchant account. It might take a up to an hour for the `LocalInventory` to be deleted from the specific product. Once you have received a successful delete response, wait for that period before attempting a delete again.
 
 Args:
-  name: string, Required. The name of the local inventory for the given product to delete. Format: `accounts/{account}/products/{product}/localInventories/{store_code}` The `{product}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123` for `store_code` "store123", the `{product}` segment must be the base64url encoding of this string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name for the local inventory would be `accounts/123/products/ZW5-VVMtc2t1LzEyMw/localInventories/store123`. 2. **Plain Format**: The `{product}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product}` segment is used to differentiate between the two formats. Note: For calls to the v1beta version, the plain format for the product segment is `channel~content_language~feed_label~offer_id`. For example, the full resource name for a local inventory at `store_code` "store123" would be: `accounts/123/products/online~en~US~sku123/localInventories/store123`. (required)
+  name: string, Required. The name of the local inventory for the given product to delete. Format: `accounts/{account}/products/{product}/localInventories/{store_code}` The `{product}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123` for `store_code` "store123", the `{product}` segment must be the base64url encoding of this string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name for the local inventory would be `accounts/123/products/ZW5-VVN-c2t1LzEyMw/localInventories/store123`. 2. **Plain Format**: The `{product}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product}` segment is used to differentiate between the two formats. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -118,7 +118,7 @@ 

Method Details

Inserts a `LocalInventory` resource to a product in your merchant account. Replaces the full `LocalInventory` resource if an entry with the same `storeCode` already exists for the product. It might take up to 30 minutes for the new or updated `LocalInventory` resource to appear in products.
 
 Args:
-  parent: string, Required. The account and product where this inventory will be inserted. Format: `accounts/{account}/products/{product}` The `{product}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{product}` segment must be the base64url encoding of this string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name for the product would be `accounts/123/products/ZW5-VVMtc2t1LzEyMw`. 2. **Plain Format**: The `{product}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product}` segment is used to differentiate between the two formats. Note: For calls to the v1beta version, the plain format is `channel~content_language~feed_label~offer_id`, for example: `accounts/123/products/online~en~US~sku123`. (required)
+  parent: string, Required. The account and product where this inventory will be inserted. Format: `accounts/{account}/products/{product}` The `{product}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{product}` segment must be the base64url encoding of this string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name for the product would be `accounts/123/products/ZW5-VVN-c2t1LzEyMw`. 2. **Plain Format**: The `{product}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product}` segment is used to differentiate between the two formats. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -163,7 +163,7 @@ 

Method Details

"startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start. }, }, - "name": "A String", # Output only. The name of the `LocalInventory` resource. Format: `accounts/{account}/products/{product}/localInventories/{store_code}` The `{product}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123` for `store_code` "store123", the `{product}` segment must be the base64url encoding of this string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name for the local inventory would be `accounts/123/products/ZW5-VVMtc2t1LzEyMw/localInventories/store123`. 2. **Plain Format**: The `{product}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product}` segment is used to differentiate between the two formats. Note: For calls to the v1beta version, the plain format for the product segment is `channel~content_language~feed_label~offer_id`. For example, the full resource name for a local inventory at `store_code` "store123" would be: `accounts/123/products/online~en~US~sku123/localInventories/store123`. + "name": "A String", # Output only. The name of the `LocalInventory` resource. Format: `accounts/{account}/products/{product}/localInventories/{store_code}` The `{product}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123` for `store_code` "store123", the `{product}` segment must be the base64url encoding of this string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name for the local inventory would be `accounts/123/products/ZW5-VVN-c2t1LzEyMw/localInventories/store123`. 2. **Plain Format**: The `{product}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product}` segment is used to differentiate between the two formats. "storeCode": "A String", # Required. Immutable. Store code (the store ID from your Business Profile) of the physical store the product is sold in. See the [Local product inventory data specification](https://support.google.com/merchants/answer/3061342) for more information. } @@ -216,7 +216,7 @@

Method Details

"startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start. }, }, - "name": "A String", # Output only. The name of the `LocalInventory` resource. Format: `accounts/{account}/products/{product}/localInventories/{store_code}` The `{product}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123` for `store_code` "store123", the `{product}` segment must be the base64url encoding of this string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name for the local inventory would be `accounts/123/products/ZW5-VVMtc2t1LzEyMw/localInventories/store123`. 2. **Plain Format**: The `{product}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product}` segment is used to differentiate between the two formats. Note: For calls to the v1beta version, the plain format for the product segment is `channel~content_language~feed_label~offer_id`. For example, the full resource name for a local inventory at `store_code` "store123" would be: `accounts/123/products/online~en~US~sku123/localInventories/store123`. + "name": "A String", # Output only. The name of the `LocalInventory` resource. Format: `accounts/{account}/products/{product}/localInventories/{store_code}` The `{product}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123` for `store_code` "store123", the `{product}` segment must be the base64url encoding of this string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name for the local inventory would be `accounts/123/products/ZW5-VVN-c2t1LzEyMw/localInventories/store123`. 2. **Plain Format**: The `{product}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product}` segment is used to differentiate between the two formats. "storeCode": "A String", # Required. Immutable. Store code (the store ID from your Business Profile) of the physical store the product is sold in. See the [Local product inventory data specification](https://support.google.com/merchants/answer/3061342) for more information. }
@@ -226,7 +226,7 @@

Method Details

Lists the `LocalInventory` resources for the given product in your merchant account. The response might contain fewer items than specified by `pageSize`. If `pageToken` was returned in previous request, it can be used to obtain additional results. `LocalInventory` resources are listed per product for a given account.
 
 Args:
-  parent: string, Required. The `name` of the parent product to list local inventories for. Format: `accounts/{account}/products/{product}` The `{product}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{product}` segment must be the base64url encoding of this string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name for the product would be `accounts/123/products/ZW5-VVMtc2t1LzEyMw`. 2. **Plain Format**: The `{product}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product}` segment is used to differentiate between the two formats. Note: For calls to the v1beta version, the plain format is `channel~content_language~feed_label~offer_id`, for example: `accounts/123/products/online~en~US~sku123`. (required)
+  parent: string, Required. The `name` of the parent product to list local inventories for. Format: `accounts/{account}/products/{product}` The `{product}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{product}` segment must be the base64url encoding of this string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name for the product would be `accounts/123/products/ZW5-VVN-c2t1LzEyMw`. 2. **Plain Format**: The `{product}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product}` segment is used to differentiate between the two formats. (required)
   pageSize: integer, The maximum number of `LocalInventory` resources for the given product to return. The service returns fewer than this value if the number of inventories for the given product is less that than the `pageSize`. The default value is 25000. The maximum value is 25000; If a value higher than the maximum is specified, then the `pageSize` will default to the maximum
   pageToken: string, A page token, received from a previous `ListLocalInventories` call. Provide the page token to retrieve the subsequent page. When paginating, all other parameters provided to `ListLocalInventories` must match the call that provided the page token. The token returned as nextPageToken in the response to the previous request.
   x__xgafv: string, V1 error format.
@@ -280,7 +280,7 @@ 

Method Details

"startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start. }, }, - "name": "A String", # Output only. The name of the `LocalInventory` resource. Format: `accounts/{account}/products/{product}/localInventories/{store_code}` The `{product}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123` for `store_code` "store123", the `{product}` segment must be the base64url encoding of this string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name for the local inventory would be `accounts/123/products/ZW5-VVMtc2t1LzEyMw/localInventories/store123`. 2. **Plain Format**: The `{product}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product}` segment is used to differentiate between the two formats. Note: For calls to the v1beta version, the plain format for the product segment is `channel~content_language~feed_label~offer_id`. For example, the full resource name for a local inventory at `store_code` "store123" would be: `accounts/123/products/online~en~US~sku123/localInventories/store123`. + "name": "A String", # Output only. The name of the `LocalInventory` resource. Format: `accounts/{account}/products/{product}/localInventories/{store_code}` The `{product}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123` for `store_code` "store123", the `{product}` segment must be the base64url encoding of this string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name for the local inventory would be `accounts/123/products/ZW5-VVN-c2t1LzEyMw/localInventories/store123`. 2. **Plain Format**: The `{product}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product}` segment is used to differentiate between the two formats. "storeCode": "A String", # Required. Immutable. Store code (the store ID from your Business Profile) of the physical store the product is sold in. See the [Local product inventory data specification](https://support.google.com/merchants/answer/3061342) for more information. }, ], diff --git a/docs/dyn/merchantapi_inventories_v1.accounts.products.regionalInventories.html b/docs/dyn/merchantapi_inventories_v1.accounts.products.regionalInventories.html index d220faeae7..0951e5438f 100644 --- a/docs/dyn/merchantapi_inventories_v1.accounts.products.regionalInventories.html +++ b/docs/dyn/merchantapi_inventories_v1.accounts.products.regionalInventories.html @@ -100,7 +100,7 @@

Method Details

Deletes the specified `RegionalInventory` resource from the given product in your merchant account. It might take up to an hour for the `RegionalInventory` to be deleted from the specific product. Once you have received a successful delete response, wait for that period before attempting a delete again.
 
 Args:
-  name: string, Required. The name of the `RegionalInventory` resource to delete. Format: `accounts/{account}/products/{product}/regionalInventories/{region}` The `{product}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123` for `region` "region123", the `{product}` segment must be the base64url encoding of this string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name for the regional inventory would be `accounts/123/products/ZW5-VVMtc2t1LzEyMw/regionalInventories/region123`. 2. **Plain Format**: The `{product}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product}` segment is used to differentiate between the two formats. Note: For calls to the v1beta version, the plain format for the product segment is `channel~content_language~feed_label~offer_id`. For example, the full resource name for a regional inventory in `region` "region123" would be: `accounts/123/products/online~en~US~sku123/regionalInventories/region123`. (required)
+  name: string, Required. The name of the `RegionalInventory` resource to delete. Format: `accounts/{account}/products/{product}/regionalInventories/{region}` The `{product}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123` for `region` "region123", the `{product}` segment must be the base64url encoding of this string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name for the regional inventory would be `accounts/123/products/ZW5-VVN-c2t1LzEyMw/regionalInventories/region123`. 2. **Plain Format**: The `{product}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product}` segment is used to differentiate between the two formats. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -118,13 +118,13 @@ 

Method Details

Inserts a `RegionalInventory` to a given product in your merchant account. Replaces the full `RegionalInventory` resource if an entry with the same `region` already exists for the product. It might take up to 30 minutes for the new or updated `RegionalInventory` resource to appear in products.
 
 Args:
-  parent: string, Required. The account and product where this inventory will be inserted. Format: `accounts/{account}/products/{product}` The `{product}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{product}` segment must be the base64url encoding of this string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name for the product would be `accounts/123/products/ZW5-VVMtc2t1LzEyMw`. 2. **Plain Format**: The `{product}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product}` segment is used to differentiate between the two formats. Note: For calls to the v1beta version, the plain format is `channel~content_language~feed_label~offer_id`, for example: `accounts/123/products/online~en~US~sku123`. (required)
+  parent: string, Required. The account and product where this inventory will be inserted. Format: `accounts/{account}/products/{product}` The `{product}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{product}` segment must be the base64url encoding of this string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name for the product would be `accounts/123/products/ZW5-VVN-c2t1LzEyMw`. 2. **Plain Format**: The `{product}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product}` segment is used to differentiate between the two formats. (required)
   body: object, The request body.
     The object takes the form of:
 
 { # Regional inventory information for the product. Represents specific information like price and availability for a given product in a specific `region`. For a list of all accepted attribute values, see the [regional product inventory data specification](https://support.google.com/merchants/answer/9698880).
   "account": "A String", # Output only. The account that owns the product. This field will be ignored if set by the client.
-  "name": "A String", # Output only. The name of the `RegionalInventory` resource. Format: `accounts/{account}/products/{product}/regionalInventories/{region}` The `{product}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123` for `region` "region123", the `{product}` segment must be the base64url encoding of this string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name for the regional inventory would be `accounts/123/products/ZW5-VVMtc2t1LzEyMw/regionalInventories/region123`. 2. **Plain Format**: The `{product}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product}` segment is used to differentiate between the two formats. Note: For calls to the v1beta version, the plain format for the product segment is `channel~content_language~feed_label~offer_id`. For example, the full resource name for a regional inventory in `region` "region123" would be: `accounts/123/products/online~en~US~sku123/regionalInventories/region123`.
+  "name": "A String", # Output only. The name of the `RegionalInventory` resource. Format: `accounts/{account}/products/{product}/regionalInventories/{region}` The `{product}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123` for `region` "region123", the `{product}` segment must be the base64url encoding of this string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name for the regional inventory would be `accounts/123/products/ZW5-VVN-c2t1LzEyMw/regionalInventories/region123`. 2. **Plain Format**: The `{product}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product}` segment is used to differentiate between the two formats.
   "region": "A String", # Required. Immutable. ID of the region for this `RegionalInventory` resource. See the [Regional availability and pricing](https://support.google.com/merchants/answer/9698880) for more details.
   "regionalInventoryAttributes": { # Regional inventory attributes. # Optional. A list of regional inventory attributes.
     "availability": "A String", # Optional. [Availability](https://support.google.com/merchants/answer/14644124) of the product in this region.
@@ -173,7 +173,7 @@ 

Method Details

{ # Regional inventory information for the product. Represents specific information like price and availability for a given product in a specific `region`. For a list of all accepted attribute values, see the [regional product inventory data specification](https://support.google.com/merchants/answer/9698880). "account": "A String", # Output only. The account that owns the product. This field will be ignored if set by the client. - "name": "A String", # Output only. The name of the `RegionalInventory` resource. Format: `accounts/{account}/products/{product}/regionalInventories/{region}` The `{product}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123` for `region` "region123", the `{product}` segment must be the base64url encoding of this string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name for the regional inventory would be `accounts/123/products/ZW5-VVMtc2t1LzEyMw/regionalInventories/region123`. 2. **Plain Format**: The `{product}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product}` segment is used to differentiate between the two formats. Note: For calls to the v1beta version, the plain format for the product segment is `channel~content_language~feed_label~offer_id`. For example, the full resource name for a regional inventory in `region` "region123" would be: `accounts/123/products/online~en~US~sku123/regionalInventories/region123`. + "name": "A String", # Output only. The name of the `RegionalInventory` resource. Format: `accounts/{account}/products/{product}/regionalInventories/{region}` The `{product}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123` for `region` "region123", the `{product}` segment must be the base64url encoding of this string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name for the regional inventory would be `accounts/123/products/ZW5-VVN-c2t1LzEyMw/regionalInventories/region123`. 2. **Plain Format**: The `{product}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product}` segment is used to differentiate between the two formats. "region": "A String", # Required. Immutable. ID of the region for this `RegionalInventory` resource. See the [Regional availability and pricing](https://support.google.com/merchants/answer/9698880) for more details. "regionalInventoryAttributes": { # Regional inventory attributes. # Optional. A list of regional inventory attributes. "availability": "A String", # Optional. [Availability](https://support.google.com/merchants/answer/14644124) of the product in this region. @@ -218,7 +218,7 @@

Method Details

Lists the `RegionalInventory` resources for the given product in your merchant account. The response might contain fewer items than specified by `pageSize`. If `pageToken` was returned in previous request, it can be used to obtain additional results. `RegionalInventory` resources are listed per product for a given account.
 
 Args:
-  parent: string, Required. The `name` of the parent product to list `RegionalInventory` resources for. Format: `accounts/{account}/products/{product}` The `{product}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{product}` segment must be the base64url encoding of this string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name for the product would be `accounts/123/products/ZW5-VVMtc2t1LzEyMw`. 2. **Plain Format**: The `{product}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product}` segment is used to differentiate between the two formats. Note: For calls to the v1beta version, the plain format is `channel~content_language~feed_label~offer_id`, for example: `accounts/123/products/online~en~US~sku123`. (required)
+  parent: string, Required. The `name` of the parent product to list `RegionalInventory` resources for. Format: `accounts/{account}/products/{product}` The `{product}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{product}` segment must be the base64url encoding of this string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name for the product would be `accounts/123/products/ZW5-VVN-c2t1LzEyMw`. 2. **Plain Format**: The `{product}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product}` segment is used to differentiate between the two formats. (required)
   pageSize: integer, The maximum number of `RegionalInventory` resources for the given product to return. The service returns fewer than this value if the number of inventories for the given product is less that than the `pageSize`. The default value is 25000. The maximum value is 100000; If a value higher than the maximum is specified, then the `pageSize` will default to the maximum.
   pageToken: string, A page token, received from a previous `ListRegionalInventories` call. Provide the page token to retrieve the subsequent page. When paginating, all other parameters provided to `ListRegionalInventories` must match the call that provided the page token. The token returned as nextPageToken in the response to the previous request.
   x__xgafv: string, V1 error format.
@@ -234,7 +234,7 @@ 

Method Details

"regionalInventories": [ # The `RegionalInventory` resources for the given product from the specified account. { # Regional inventory information for the product. Represents specific information like price and availability for a given product in a specific `region`. For a list of all accepted attribute values, see the [regional product inventory data specification](https://support.google.com/merchants/answer/9698880). "account": "A String", # Output only. The account that owns the product. This field will be ignored if set by the client. - "name": "A String", # Output only. The name of the `RegionalInventory` resource. Format: `accounts/{account}/products/{product}/regionalInventories/{region}` The `{product}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123` for `region` "region123", the `{product}` segment must be the base64url encoding of this string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name for the regional inventory would be `accounts/123/products/ZW5-VVMtc2t1LzEyMw/regionalInventories/region123`. 2. **Plain Format**: The `{product}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product}` segment is used to differentiate between the two formats. Note: For calls to the v1beta version, the plain format for the product segment is `channel~content_language~feed_label~offer_id`. For example, the full resource name for a regional inventory in `region` "region123" would be: `accounts/123/products/online~en~US~sku123/regionalInventories/region123`. + "name": "A String", # Output only. The name of the `RegionalInventory` resource. Format: `accounts/{account}/products/{product}/regionalInventories/{region}` The `{product}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123` for `region` "region123", the `{product}` segment must be the base64url encoding of this string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name for the regional inventory would be `accounts/123/products/ZW5-VVN-c2t1LzEyMw/regionalInventories/region123`. 2. **Plain Format**: The `{product}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product}` segment is used to differentiate between the two formats. "region": "A String", # Required. Immutable. ID of the region for this `RegionalInventory` resource. See the [Regional availability and pricing](https://support.google.com/merchants/answer/9698880) for more details. "regionalInventoryAttributes": { # Regional inventory attributes. # Optional. A list of regional inventory attributes. "availability": "A String", # Optional. [Availability](https://support.google.com/merchants/answer/14644124) of the product in this region. diff --git a/docs/dyn/merchantapi_inventories_v1beta.accounts.products.localInventories.html b/docs/dyn/merchantapi_inventories_v1beta.accounts.products.localInventories.html index 6c4a94e433..0b4927309f 100644 --- a/docs/dyn/merchantapi_inventories_v1beta.accounts.products.localInventories.html +++ b/docs/dyn/merchantapi_inventories_v1beta.accounts.products.localInventories.html @@ -100,7 +100,7 @@

Method Details

Deletes the specified `LocalInventory` from the given product in your merchant account. It might take a up to an hour for the `LocalInventory` to be deleted from the specific product. Once you have received a successful delete response, wait for that period before attempting a delete again.
 
 Args:
-  name: string, Required. The name of the local inventory for the given product to delete. Format: `accounts/{account}/products/{product}/localInventories/{store_code}` The `{product}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123` for `store_code` "store123", the `{product}` segment must be the base64url encoding of this string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name for the local inventory would be `accounts/123/products/ZW5-VVMtc2t1LzEyMw/localInventories/store123`. 2. **Plain Format**: The `{product}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product}` segment is used to differentiate between the two formats. Note: For calls to the v1beta version, the plain format for the product segment is `channel~content_language~feed_label~offer_id`. For example, the full resource name for a local inventory at `store_code` "store123" would be: `accounts/123/products/online~en~US~sku123/localInventories/store123`. (required)
+  name: string, Required. The name of the local inventory for the given product to delete. Format: `accounts/{account}/products/{product}/localInventories/{store_code}` The `{product}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123` for `store_code` "store123", the `{product}` segment must be the base64url encoding of this string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name for the local inventory would be `accounts/123/products/ZW5-VVN-c2t1LzEyMw/localInventories/store123`. 2. **Plain Format**: The `{product}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product}` segment is used to differentiate between the two formats. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -118,7 +118,7 @@ 

Method Details

Inserts a `LocalInventory` resource to a product in your merchant account. Replaces the full `LocalInventory` resource if an entry with the same `storeCode` already exists for the product. It might take up to 30 minutes for the new or updated `LocalInventory` resource to appear in products.
 
 Args:
-  parent: string, Required. The account and product where this inventory will be inserted. Format: `accounts/{account}/products/{product}` The `{product}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{product}` segment must be the base64url encoding of this string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name for the product would be `accounts/123/products/ZW5-VVMtc2t1LzEyMw`. 2. **Plain Format**: The `{product}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product}` segment is used to differentiate between the two formats. Note: For calls to the v1beta version, the plain format is `channel~content_language~feed_label~offer_id`, for example: `accounts/123/products/online~en~US~sku123`. (required)
+  parent: string, Required. The account and product where this inventory will be inserted. Format: `accounts/{account}/products/{product}` The `{product}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{product}` segment must be the base64url encoding of this string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name for the product would be `accounts/123/products/ZW5-VVN-c2t1LzEyMw`. 2. **Plain Format**: The `{product}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product}` segment is used to differentiate between the two formats. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -135,7 +135,7 @@ 

Method Details

}, ], "instoreProductLocation": "A String", # Location of the product inside the store. Maximum length is 20 bytes. - "name": "A String", # Output only. The name of the `LocalInventory` resource. Format: `accounts/{account}/products/{product}/localInventories/{store_code}` The `{product}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123` for `store_code` "store123", the `{product}` segment must be the base64url encoding of this string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name for the local inventory would be `accounts/123/products/ZW5-VVMtc2t1LzEyMw/localInventories/store123`. 2. **Plain Format**: The `{product}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product}` segment is used to differentiate between the two formats. Note: For calls to the v1beta version, the plain format for the product segment is `channel~content_language~feed_label~offer_id`. For example, the full resource name for a local inventory at `store_code` "store123" would be: `accounts/123/products/online~en~US~sku123/localInventories/store123`. + "name": "A String", # Output only. The name of the `LocalInventory` resource. Format: `accounts/{account}/products/{product}/localInventories/{store_code}` The `{product}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123` for `store_code` "store123", the `{product}` segment must be the base64url encoding of this string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name for the local inventory would be `accounts/123/products/ZW5-VVN-c2t1LzEyMw/localInventories/store123`. 2. **Plain Format**: The `{product}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product}` segment is used to differentiate between the two formats. "pickupMethod": "A String", # Supported pickup method for this product. Unless the value is `"not supported"`, this field must be submitted together with `pickupSla`. For accepted attribute values, see the [local product inventory data specification](https://support.google.com/merchants/answer/3061342) "pickupSla": "A String", # Relative time period from the order date for an order for this product, from this store, to be ready for pickup. Must be submitted with `pickupMethod`. For accepted attribute values, see the [local product inventory data specification](https://support.google.com/merchants/answer/3061342) "price": { # The price represented as a number and currency. # Optional. Price of the product at this store. @@ -175,7 +175,7 @@

Method Details

}, ], "instoreProductLocation": "A String", # Location of the product inside the store. Maximum length is 20 bytes. - "name": "A String", # Output only. The name of the `LocalInventory` resource. Format: `accounts/{account}/products/{product}/localInventories/{store_code}` The `{product}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123` for `store_code` "store123", the `{product}` segment must be the base64url encoding of this string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name for the local inventory would be `accounts/123/products/ZW5-VVMtc2t1LzEyMw/localInventories/store123`. 2. **Plain Format**: The `{product}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product}` segment is used to differentiate between the two formats. Note: For calls to the v1beta version, the plain format for the product segment is `channel~content_language~feed_label~offer_id`. For example, the full resource name for a local inventory at `store_code` "store123" would be: `accounts/123/products/online~en~US~sku123/localInventories/store123`. + "name": "A String", # Output only. The name of the `LocalInventory` resource. Format: `accounts/{account}/products/{product}/localInventories/{store_code}` The `{product}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123` for `store_code` "store123", the `{product}` segment must be the base64url encoding of this string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name for the local inventory would be `accounts/123/products/ZW5-VVN-c2t1LzEyMw/localInventories/store123`. 2. **Plain Format**: The `{product}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product}` segment is used to differentiate between the two formats. "pickupMethod": "A String", # Supported pickup method for this product. Unless the value is `"not supported"`, this field must be submitted together with `pickupSla`. For accepted attribute values, see the [local product inventory data specification](https://support.google.com/merchants/answer/3061342) "pickupSla": "A String", # Relative time period from the order date for an order for this product, from this store, to be ready for pickup. Must be submitted with `pickupMethod`. For accepted attribute values, see the [local product inventory data specification](https://support.google.com/merchants/answer/3061342) "price": { # The price represented as a number and currency. # Optional. Price of the product at this store. @@ -200,7 +200,7 @@

Method Details

Lists the `LocalInventory` resources for the given product in your merchant account. The response might contain fewer items than specified by `pageSize`. If `pageToken` was returned in previous request, it can be used to obtain additional results. `LocalInventory` resources are listed per product for a given account.
 
 Args:
-  parent: string, Required. The `name` of the parent product to list local inventories for. Format: `accounts/{account}/products/{product}` The `{product}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{product}` segment must be the base64url encoding of this string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name for the product would be `accounts/123/products/ZW5-VVMtc2t1LzEyMw`. 2. **Plain Format**: The `{product}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product}` segment is used to differentiate between the two formats. Note: For calls to the v1beta version, the plain format is `channel~content_language~feed_label~offer_id`, for example: `accounts/123/products/online~en~US~sku123`. (required)
+  parent: string, Required. The `name` of the parent product to list local inventories for. Format: `accounts/{account}/products/{product}` The `{product}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{product}` segment must be the base64url encoding of this string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name for the product would be `accounts/123/products/ZW5-VVN-c2t1LzEyMw`. 2. **Plain Format**: The `{product}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product}` segment is used to differentiate between the two formats. (required)
   pageSize: integer, The maximum number of `LocalInventory` resources for the given product to return. The service returns fewer than this value if the number of inventories for the given product is less that than the `pageSize`. The default value is 25000. The maximum value is 25000; If a value higher than the maximum is specified, then the `pageSize` will default to the maximum
   pageToken: string, A page token, received from a previous `ListLocalInventories` call. Provide the page token to retrieve the subsequent page. When paginating, all other parameters provided to `ListLocalInventories` must match the call that provided the page token. The token returned as nextPageToken in the response to the previous request.
   x__xgafv: string, V1 error format.
@@ -226,7 +226,7 @@ 

Method Details

}, ], "instoreProductLocation": "A String", # Location of the product inside the store. Maximum length is 20 bytes. - "name": "A String", # Output only. The name of the `LocalInventory` resource. Format: `accounts/{account}/products/{product}/localInventories/{store_code}` The `{product}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123` for `store_code` "store123", the `{product}` segment must be the base64url encoding of this string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name for the local inventory would be `accounts/123/products/ZW5-VVMtc2t1LzEyMw/localInventories/store123`. 2. **Plain Format**: The `{product}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product}` segment is used to differentiate between the two formats. Note: For calls to the v1beta version, the plain format for the product segment is `channel~content_language~feed_label~offer_id`. For example, the full resource name for a local inventory at `store_code` "store123" would be: `accounts/123/products/online~en~US~sku123/localInventories/store123`. + "name": "A String", # Output only. The name of the `LocalInventory` resource. Format: `accounts/{account}/products/{product}/localInventories/{store_code}` The `{product}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123` for `store_code` "store123", the `{product}` segment must be the base64url encoding of this string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name for the local inventory would be `accounts/123/products/ZW5-VVN-c2t1LzEyMw/localInventories/store123`. 2. **Plain Format**: The `{product}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product}` segment is used to differentiate between the two formats. "pickupMethod": "A String", # Supported pickup method for this product. Unless the value is `"not supported"`, this field must be submitted together with `pickupSla`. For accepted attribute values, see the [local product inventory data specification](https://support.google.com/merchants/answer/3061342) "pickupSla": "A String", # Relative time period from the order date for an order for this product, from this store, to be ready for pickup. Must be submitted with `pickupMethod`. For accepted attribute values, see the [local product inventory data specification](https://support.google.com/merchants/answer/3061342) "price": { # The price represented as a number and currency. # Optional. Price of the product at this store. diff --git a/docs/dyn/merchantapi_inventories_v1beta.accounts.products.regionalInventories.html b/docs/dyn/merchantapi_inventories_v1beta.accounts.products.regionalInventories.html index 512274bb78..3c9f493fff 100644 --- a/docs/dyn/merchantapi_inventories_v1beta.accounts.products.regionalInventories.html +++ b/docs/dyn/merchantapi_inventories_v1beta.accounts.products.regionalInventories.html @@ -100,7 +100,7 @@

Method Details

Deletes the specified `RegionalInventory` resource from the given product in your merchant account. It might take up to an hour for the `RegionalInventory` to be deleted from the specific product. Once you have received a successful delete response, wait for that period before attempting a delete again.
 
 Args:
-  name: string, Required. The name of the `RegionalInventory` resource to delete. Format: `accounts/{account}/products/{product}/regionalInventories/{region}` The `{product}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123` for `region` "region123", the `{product}` segment must be the base64url encoding of this string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name for the regional inventory would be `accounts/123/products/ZW5-VVMtc2t1LzEyMw/regionalInventories/region123`. 2. **Plain Format**: The `{product}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product}` segment is used to differentiate between the two formats. Note: For calls to the v1beta version, the plain format for the product segment is `channel~content_language~feed_label~offer_id`. For example, the full resource name for a regional inventory in `region` "region123" would be: `accounts/123/products/online~en~US~sku123/regionalInventories/region123`. (required)
+  name: string, Required. The name of the `RegionalInventory` resource to delete. Format: `accounts/{account}/products/{product}/regionalInventories/{region}` The `{product}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123` for `region` "region123", the `{product}` segment must be the base64url encoding of this string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name for the regional inventory would be `accounts/123/products/ZW5-VVN-c2t1LzEyMw/regionalInventories/region123`. 2. **Plain Format**: The `{product}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product}` segment is used to differentiate between the two formats. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -118,7 +118,7 @@ 

Method Details

Inserts a `RegionalInventory` to a given product in your merchant account. Replaces the full `RegionalInventory` resource if an entry with the same `region` already exists for the product. It might take up to 30 minutes for the new or updated `RegionalInventory` resource to appear in products.
 
 Args:
-  parent: string, Required. The account and product where this inventory will be inserted. Format: `accounts/{account}/products/{product}` The `{product}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{product}` segment must be the base64url encoding of this string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name for the product would be `accounts/123/products/ZW5-VVMtc2t1LzEyMw`. 2. **Plain Format**: The `{product}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product}` segment is used to differentiate between the two formats. Note: For calls to the v1beta version, the plain format is `channel~content_language~feed_label~offer_id`, for example: `accounts/123/products/online~en~US~sku123`. (required)
+  parent: string, Required. The account and product where this inventory will be inserted. Format: `accounts/{account}/products/{product}` The `{product}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{product}` segment must be the base64url encoding of this string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name for the product would be `accounts/123/products/ZW5-VVN-c2t1LzEyMw`. 2. **Plain Format**: The `{product}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product}` segment is used to differentiate between the two formats. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -134,7 +134,7 @@ 

Method Details

"value": "A String", # The value of the attribute. If `value` is not empty, `group_values` must be empty. }, ], - "name": "A String", # Output only. The name of the `RegionalInventory` resource. Format: `accounts/{account}/products/{product}/regionalInventories/{region}` The `{product}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123` for `region` "region123", the `{product}` segment must be the base64url encoding of this string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name for the regional inventory would be `accounts/123/products/ZW5-VVMtc2t1LzEyMw/regionalInventories/region123`. 2. **Plain Format**: The `{product}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product}` segment is used to differentiate between the two formats. Note: For calls to the v1beta version, the plain format for the product segment is `channel~content_language~feed_label~offer_id`. For example, the full resource name for a regional inventory in `region` "region123" would be: `accounts/123/products/online~en~US~sku123/regionalInventories/region123`. + "name": "A String", # Output only. The name of the `RegionalInventory` resource. Format: `accounts/{account}/products/{product}/regionalInventories/{region}` The `{product}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123` for `region` "region123", the `{product}` segment must be the base64url encoding of this string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name for the regional inventory would be `accounts/123/products/ZW5-VVN-c2t1LzEyMw/regionalInventories/region123`. 2. **Plain Format**: The `{product}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product}` segment is used to differentiate between the two formats. "price": { # The price represented as a number and currency. # Optional. Price of the product in this region. "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). @@ -170,7 +170,7 @@

Method Details

"value": "A String", # The value of the attribute. If `value` is not empty, `group_values` must be empty. }, ], - "name": "A String", # Output only. The name of the `RegionalInventory` resource. Format: `accounts/{account}/products/{product}/regionalInventories/{region}` The `{product}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123` for `region` "region123", the `{product}` segment must be the base64url encoding of this string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name for the regional inventory would be `accounts/123/products/ZW5-VVMtc2t1LzEyMw/regionalInventories/region123`. 2. **Plain Format**: The `{product}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product}` segment is used to differentiate between the two formats. Note: For calls to the v1beta version, the plain format for the product segment is `channel~content_language~feed_label~offer_id`. For example, the full resource name for a regional inventory in `region` "region123" would be: `accounts/123/products/online~en~US~sku123/regionalInventories/region123`. + "name": "A String", # Output only. The name of the `RegionalInventory` resource. Format: `accounts/{account}/products/{product}/regionalInventories/{region}` The `{product}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123` for `region` "region123", the `{product}` segment must be the base64url encoding of this string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name for the regional inventory would be `accounts/123/products/ZW5-VVN-c2t1LzEyMw/regionalInventories/region123`. 2. **Plain Format**: The `{product}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product}` segment is used to differentiate between the two formats. "price": { # The price represented as a number and currency. # Optional. Price of the product in this region. "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). @@ -192,7 +192,7 @@

Method Details

Lists the `RegionalInventory` resources for the given product in your merchant account. The response might contain fewer items than specified by `pageSize`. If `pageToken` was returned in previous request, it can be used to obtain additional results. `RegionalInventory` resources are listed per product for a given account.
 
 Args:
-  parent: string, Required. The `name` of the parent product to list `RegionalInventory` resources for. Format: `accounts/{account}/products/{product}` The `{product}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{product}` segment must be the base64url encoding of this string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name for the product would be `accounts/123/products/ZW5-VVMtc2t1LzEyMw`. 2. **Plain Format**: The `{product}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product}` segment is used to differentiate between the two formats. Note: For calls to the v1beta version, the plain format is `channel~content_language~feed_label~offer_id`, for example: `accounts/123/products/online~en~US~sku123`. (required)
+  parent: string, Required. The `name` of the parent product to list `RegionalInventory` resources for. Format: `accounts/{account}/products/{product}` The `{product}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{product}` segment must be the base64url encoding of this string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name for the product would be `accounts/123/products/ZW5-VVN-c2t1LzEyMw`. 2. **Plain Format**: The `{product}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product}` segment is used to differentiate between the two formats. (required)
   pageSize: integer, The maximum number of `RegionalInventory` resources for the given product to return. The service returns fewer than this value if the number of inventories for the given product is less that than the `pageSize`. The default value is 25000. The maximum value is 100000; If a value higher than the maximum is specified, then the `pageSize` will default to the maximum.
   pageToken: string, A page token, received from a previous `ListRegionalInventories` call. Provide the page token to retrieve the subsequent page. When paginating, all other parameters provided to `ListRegionalInventories` must match the call that provided the page token. The token returned as nextPageToken in the response to the previous request.
   x__xgafv: string, V1 error format.
@@ -218,7 +218,7 @@ 

Method Details

"value": "A String", # The value of the attribute. If `value` is not empty, `group_values` must be empty. }, ], - "name": "A String", # Output only. The name of the `RegionalInventory` resource. Format: `accounts/{account}/products/{product}/regionalInventories/{region}` The `{product}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123` for `region` "region123", the `{product}` segment must be the base64url encoding of this string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name for the regional inventory would be `accounts/123/products/ZW5-VVMtc2t1LzEyMw/regionalInventories/region123`. 2. **Plain Format**: The `{product}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product}` segment is used to differentiate between the two formats. Note: For calls to the v1beta version, the plain format for the product segment is `channel~content_language~feed_label~offer_id`. For example, the full resource name for a regional inventory in `region` "region123" would be: `accounts/123/products/online~en~US~sku123/regionalInventories/region123`. + "name": "A String", # Output only. The name of the `RegionalInventory` resource. Format: `accounts/{account}/products/{product}/regionalInventories/{region}` The `{product}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123` for `region` "region123", the `{product}` segment must be the base64url encoding of this string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name for the regional inventory would be `accounts/123/products/ZW5-VVN-c2t1LzEyMw/regionalInventories/region123`. 2. **Plain Format**: The `{product}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product}` segment is used to differentiate between the two formats. "price": { # The price represented as a number and currency. # Optional. Price of the product in this region. "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). diff --git a/docs/dyn/merchantapi_issueresolution_v1.issueresolution.html b/docs/dyn/merchantapi_issueresolution_v1.issueresolution.html index 84338dfc67..8c780932a4 100644 --- a/docs/dyn/merchantapi_issueresolution_v1.issueresolution.html +++ b/docs/dyn/merchantapi_issueresolution_v1.issueresolution.html @@ -236,7 +236,7 @@

Method Details

Provide a list of issues for business's product with an issue resolution content and available actions. This content and actions are meant to be rendered and shown in third-party applications.
 
 Args:
-  name: string, Required. The name of the product. Format: `accounts/{account}/products/{product}` The `{product}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{product}` segment must be the base64url encoding of this string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name for the product would be `accounts/123/products/ZW5-VVMtc2t1LzEyMw`. 2. **Plain Format**: The `{product}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product}` segment is used to differentiate between the two formats. Note: For calls to the v1beta version, the plain format is `channel~content_language~feed_label~offer_id`, for example: `accounts/123/products/online~en~US~sku123`. (required)
+  name: string, Required. The name of the product. Format: `accounts/{account}/products/{product}` The `{product}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{product}` segment must be the base64url encoding of this string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name for the product would be `accounts/123/products/ZW5-VVN-c2t1LzEyMw`. 2. **Plain Format**: The `{product}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product}` segment is used to differentiate between the two formats. (required)
   body: object, The request body.
     The object takes the form of:
 
diff --git a/docs/dyn/merchantapi_issueresolution_v1beta.issueresolution.html b/docs/dyn/merchantapi_issueresolution_v1beta.issueresolution.html
index 1a7ffad31c..faffcb26b1 100644
--- a/docs/dyn/merchantapi_issueresolution_v1beta.issueresolution.html
+++ b/docs/dyn/merchantapi_issueresolution_v1beta.issueresolution.html
@@ -236,7 +236,7 @@ 

Method Details

Provide a list of issues for business's product with an issue resolution content and available actions. This content and actions are meant to be rendered and shown in third-party applications.
 
 Args:
-  name: string, Required. The name of the product. Format: `accounts/{account}/products/{product}` The `{product}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{product}` segment must be the base64url encoding of this string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name for the product would be `accounts/123/products/ZW5-VVMtc2t1LzEyMw`. 2. **Plain Format**: The `{product}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product}` segment is used to differentiate between the two formats. Note: For calls to the v1beta version, the plain format is `channel~content_language~feed_label~offer_id`, for example: `accounts/123/products/online~en~US~sku123`. (required)
+  name: string, Required. The name of the product. Format: `accounts/{account}/products/{product}` The `{product}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{product}` segment must be the base64url encoding of this string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name for the product would be `accounts/123/products/ZW5-VVN-c2t1LzEyMw`. 2. **Plain Format**: The `{product}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product}` segment is used to differentiate between the two formats. (required)
   body: object, The request body.
     The object takes the form of:
 
diff --git a/docs/dyn/merchantapi_products_v1.accounts.productInputs.html b/docs/dyn/merchantapi_products_v1.accounts.productInputs.html
index a815bd4ebf..87db4090a4 100644
--- a/docs/dyn/merchantapi_products_v1.accounts.productInputs.html
+++ b/docs/dyn/merchantapi_products_v1.accounts.productInputs.html
@@ -97,7 +97,7 @@ 

Method Details

Deletes a product input from your Merchant Center account. After inserting, updating, or deleting a product input, it may take several minutes before the processed product can be retrieved.
 
 Args:
-  name: string, Required. The name of the product input to delete. Format: `accounts/{account}/productInputs/{productInput}` The {productInput} segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the {productInput} segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{productInput}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{productInput}` segment must be the base64url encoding of this string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name for the product would be `accounts/123/productInputs/ZW5-VVMtc2t1LzEyMw`. 2. **Plain Format**: The `{productInput}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{productInput}` segment is used to differentiate between the two formats. Note: For calls to the v1beta version, the plain format is `channel~content_language~feed_label~offer_id`, for example: `accounts/123/productinputs/online~en~US~sku123`. (required)
+  name: string, Required. The name of the product input to delete. Format: `accounts/{account}/productInputs/{productInput}` The {productInput} segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the {productInput} segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{productInput}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{productInput}` segment must be the base64url encoding of this string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name for the product would be `accounts/123/productInputs/ZW5-VVN-c2t1LzEyMw`. 2. **Plain Format**: The `{productInput}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{productInput}` segment is used to differentiate between the two formats. (required)
   dataSource: string, Required. The primary or supplemental data source from which the product input should be deleted. Format: `accounts/{account}/dataSources/{datasource}`. For example, `accounts/123456/dataSources/104628`.
   x__xgafv: string, V1 error format.
     Allowed values
@@ -133,7 +133,7 @@ 

Method Details

], "feedLabel": "A String", # Required. Immutable. The feed label that lets you categorize and identify your products. The maximum allowed characters are 20, and the supported characters are `A-Z`, `0-9`, hyphen, and underscore. The feed label must not include any spaces. For more information, see [Using feed labels](//support.google.com/merchants/answer/14994087). "legacyLocal": True or False, # Immutable. Determines whether the product is **only** targeting local destinations and whether the product name should be distinguished with a `local~` prefix. For example, `accounts/123/productInputs/local~en~US~sku123`. If a product that is not `legacy_local` is already targeting local destinations, creating a `legacy_local` product with an otherwise matching name will fail. - "name": "A String", # Identifier. The name of the product. Format: `accounts/{account}/productInputs/{productinput}` The {productinput} segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the {productinput} segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{productinput}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{productinput}` segment must be the base64url encoding of this string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name for the product would be `accounts/123/productinputs/ZW5-VVMtc2t1LzEyMw`. 2. **Plain Format**: The `{productinput}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{productinput}` segment is used to differentiate between the two formats. Note: For calls to the v1beta version, the plain format is `channel~content_language~feed_label~offer_id`, for example: `accounts/123/productinputs/online~en~US~sku123`. + "name": "A String", # Identifier. The name of the product. Format: `accounts/{account}/productInputs/{productinput}` The {productinput} segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the {productinput} segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{productinput}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{productinput}` segment must be the base64url encoding of this string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name for the product would be `accounts/123/productInputs/ZW5-VVN-c2t1LzEyMw`. 2. **Plain Format**: The `{productinput}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{productinput}` segment is used to differentiate between the two formats. "offerId": "A String", # Required. Immutable. Your unique identifier for the product. This is the same for the product input and processed product. Leading and trailing whitespaces are stripped and multiple whitespaces are replaced by a single whitespace upon submission. See the [products data specification](https://support.google.com/merchants/answer/188494#id) for details. "product": "A String", # Output only. The name of the processed product. Format: `accounts/{account}/products/{product}` "productAttributes": { # Product attributes. # Optional. A list of strongly-typed product attributes. @@ -484,7 +484,7 @@

Method Details

], "feedLabel": "A String", # Required. Immutable. The feed label that lets you categorize and identify your products. The maximum allowed characters are 20, and the supported characters are `A-Z`, `0-9`, hyphen, and underscore. The feed label must not include any spaces. For more information, see [Using feed labels](//support.google.com/merchants/answer/14994087). "legacyLocal": True or False, # Immutable. Determines whether the product is **only** targeting local destinations and whether the product name should be distinguished with a `local~` prefix. For example, `accounts/123/productInputs/local~en~US~sku123`. If a product that is not `legacy_local` is already targeting local destinations, creating a `legacy_local` product with an otherwise matching name will fail. - "name": "A String", # Identifier. The name of the product. Format: `accounts/{account}/productInputs/{productinput}` The {productinput} segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the {productinput} segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{productinput}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{productinput}` segment must be the base64url encoding of this string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name for the product would be `accounts/123/productinputs/ZW5-VVMtc2t1LzEyMw`. 2. **Plain Format**: The `{productinput}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{productinput}` segment is used to differentiate between the two formats. Note: For calls to the v1beta version, the plain format is `channel~content_language~feed_label~offer_id`, for example: `accounts/123/productinputs/online~en~US~sku123`. + "name": "A String", # Identifier. The name of the product. Format: `accounts/{account}/productInputs/{productinput}` The {productinput} segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the {productinput} segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{productinput}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{productinput}` segment must be the base64url encoding of this string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name for the product would be `accounts/123/productInputs/ZW5-VVN-c2t1LzEyMw`. 2. **Plain Format**: The `{productinput}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{productinput}` segment is used to differentiate between the two formats. "offerId": "A String", # Required. Immutable. Your unique identifier for the product. This is the same for the product input and processed product. Leading and trailing whitespaces are stripped and multiple whitespaces are replaced by a single whitespace upon submission. See the [products data specification](https://support.google.com/merchants/answer/188494#id) for details. "product": "A String", # Output only. The name of the processed product. Format: `accounts/{account}/products/{product}` "productAttributes": { # Product attributes. # Optional. A list of strongly-typed product attributes. @@ -819,7 +819,7 @@

Method Details

Updates the existing product input in your Merchant Center account. The name of the product input to update is taken from the `name` field within the `ProductInput` resource. After inserting, updating, or deleting a product input, it may take several minutes before the processed product can be retrieved.
 
 Args:
-  name: string, Identifier. The name of the product. Format: `accounts/{account}/productInputs/{productinput}` The {productinput} segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the {productinput} segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{productinput}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{productinput}` segment must be the base64url encoding of this string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name for the product would be `accounts/123/productinputs/ZW5-VVMtc2t1LzEyMw`. 2. **Plain Format**: The `{productinput}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{productinput}` segment is used to differentiate between the two formats. Note: For calls to the v1beta version, the plain format is `channel~content_language~feed_label~offer_id`, for example: `accounts/123/productinputs/online~en~US~sku123`. (required)
+  name: string, Identifier. The name of the product. Format: `accounts/{account}/productInputs/{productinput}` The {productinput} segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the {productinput} segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{productinput}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{productinput}` segment must be the base64url encoding of this string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name for the product would be `accounts/123/productInputs/ZW5-VVN-c2t1LzEyMw`. 2. **Plain Format**: The `{productinput}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{productinput}` segment is used to differentiate between the two formats. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -836,7 +836,7 @@ 

Method Details

], "feedLabel": "A String", # Required. Immutable. The feed label that lets you categorize and identify your products. The maximum allowed characters are 20, and the supported characters are `A-Z`, `0-9`, hyphen, and underscore. The feed label must not include any spaces. For more information, see [Using feed labels](//support.google.com/merchants/answer/14994087). "legacyLocal": True or False, # Immutable. Determines whether the product is **only** targeting local destinations and whether the product name should be distinguished with a `local~` prefix. For example, `accounts/123/productInputs/local~en~US~sku123`. If a product that is not `legacy_local` is already targeting local destinations, creating a `legacy_local` product with an otherwise matching name will fail. - "name": "A String", # Identifier. The name of the product. Format: `accounts/{account}/productInputs/{productinput}` The {productinput} segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the {productinput} segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{productinput}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{productinput}` segment must be the base64url encoding of this string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name for the product would be `accounts/123/productinputs/ZW5-VVMtc2t1LzEyMw`. 2. **Plain Format**: The `{productinput}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{productinput}` segment is used to differentiate between the two formats. Note: For calls to the v1beta version, the plain format is `channel~content_language~feed_label~offer_id`, for example: `accounts/123/productinputs/online~en~US~sku123`. + "name": "A String", # Identifier. The name of the product. Format: `accounts/{account}/productInputs/{productinput}` The {productinput} segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the {productinput} segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{productinput}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{productinput}` segment must be the base64url encoding of this string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name for the product would be `accounts/123/productInputs/ZW5-VVN-c2t1LzEyMw`. 2. **Plain Format**: The `{productinput}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{productinput}` segment is used to differentiate between the two formats. "offerId": "A String", # Required. Immutable. Your unique identifier for the product. This is the same for the product input and processed product. Leading and trailing whitespaces are stripped and multiple whitespaces are replaced by a single whitespace upon submission. See the [products data specification](https://support.google.com/merchants/answer/188494#id) for details. "product": "A String", # Output only. The name of the processed product. Format: `accounts/{account}/products/{product}` "productAttributes": { # Product attributes. # Optional. A list of strongly-typed product attributes. @@ -1188,7 +1188,7 @@

Method Details

], "feedLabel": "A String", # Required. Immutable. The feed label that lets you categorize and identify your products. The maximum allowed characters are 20, and the supported characters are `A-Z`, `0-9`, hyphen, and underscore. The feed label must not include any spaces. For more information, see [Using feed labels](//support.google.com/merchants/answer/14994087). "legacyLocal": True or False, # Immutable. Determines whether the product is **only** targeting local destinations and whether the product name should be distinguished with a `local~` prefix. For example, `accounts/123/productInputs/local~en~US~sku123`. If a product that is not `legacy_local` is already targeting local destinations, creating a `legacy_local` product with an otherwise matching name will fail. - "name": "A String", # Identifier. The name of the product. Format: `accounts/{account}/productInputs/{productinput}` The {productinput} segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the {productinput} segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{productinput}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{productinput}` segment must be the base64url encoding of this string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name for the product would be `accounts/123/productinputs/ZW5-VVMtc2t1LzEyMw`. 2. **Plain Format**: The `{productinput}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{productinput}` segment is used to differentiate between the two formats. Note: For calls to the v1beta version, the plain format is `channel~content_language~feed_label~offer_id`, for example: `accounts/123/productinputs/online~en~US~sku123`. + "name": "A String", # Identifier. The name of the product. Format: `accounts/{account}/productInputs/{productinput}` The {productinput} segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the {productinput} segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{productinput}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{productinput}` segment must be the base64url encoding of this string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name for the product would be `accounts/123/productInputs/ZW5-VVN-c2t1LzEyMw`. 2. **Plain Format**: The `{productinput}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{productinput}` segment is used to differentiate between the two formats. "offerId": "A String", # Required. Immutable. Your unique identifier for the product. This is the same for the product input and processed product. Leading and trailing whitespaces are stripped and multiple whitespaces are replaced by a single whitespace upon submission. See the [products data specification](https://support.google.com/merchants/answer/188494#id) for details. "product": "A String", # Output only. The name of the processed product. Format: `accounts/{account}/products/{product}` "productAttributes": { # Product attributes. # Optional. A list of strongly-typed product attributes. diff --git a/docs/dyn/merchantapi_products_v1beta.accounts.productInputs.html b/docs/dyn/merchantapi_products_v1beta.accounts.productInputs.html index 38f452d373..9e813172a2 100644 --- a/docs/dyn/merchantapi_products_v1beta.accounts.productInputs.html +++ b/docs/dyn/merchantapi_products_v1beta.accounts.productInputs.html @@ -97,7 +97,7 @@

Method Details

Deletes a product input from your Merchant Center account. After inserting, updating, or deleting a product input, it may take several minutes before the processed product can be retrieved.
 
 Args:
-  name: string, Required. The name of the product input to delete. Format: `accounts/{account}/productInputs/{productInput}` The {productInput} segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the {productInput} segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{productInput}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{productInput}` segment must be the base64url encoding of this string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name for the product would be `accounts/123/productInputs/ZW5-VVMtc2t1LzEyMw`. 2. **Plain Format**: The `{productInput}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{productInput}` segment is used to differentiate between the two formats. Note: For calls to the v1beta version, the plain format is `channel~content_language~feed_label~offer_id`, for example: `accounts/123/productinputs/online~en~US~sku123`. (required)
+  name: string, Required. The name of the product input to delete. Format: `accounts/{account}/productInputs/{productInput}` The {productInput} segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the {productInput} segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{productInput}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{productInput}` segment must be the base64url encoding of this string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name for the product would be `accounts/123/productInputs/ZW5-VVN-c2t1LzEyMw`. 2. **Plain Format**: The `{productInput}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{productInput}` segment is used to differentiate between the two formats. (required)
   dataSource: string, Required. The primary or supplemental data source from which the product input should be deleted. Format: `accounts/{account}/dataSources/{datasource}`. For example, `accounts/123456/dataSources/104628`.
   x__xgafv: string, V1 error format.
     Allowed values
@@ -426,7 +426,7 @@ 

Method Details

}, ], "feedLabel": "A String", # Required. Immutable. The feed label that lets you categorize and identify your products. The maximum allowed characters are 20, and the supported characters are `A-Z`, `0-9`, hyphen, and underscore. The feed label must not include any spaces. For more information, see [Using feed labels](//support.google.com/merchants/answer/14994087). - "name": "A String", # Identifier. The name of the product. Format: `accounts/{account}/productInputs/{productinput}` The {productinput} segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the {productinput} segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{productinput}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{productinput}` segment must be the base64url encoding of this string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name for the product would be `accounts/123/productinputs/ZW5-VVMtc2t1LzEyMw`. 2. **Plain Format**: The `{productinput}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{productinput}` segment is used to differentiate between the two formats. Note: For calls to the v1beta version, the plain format is `channel~content_language~feed_label~offer_id`, for example: `accounts/123/productinputs/online~en~US~sku123`. + "name": "A String", # Identifier. The name of the product. Format: `accounts/{account}/productInputs/{productinput}` The {productinput} segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the {productinput} segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{productinput}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{productinput}` segment must be the base64url encoding of this string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name for the product would be `accounts/123/productInputs/ZW5-VVN-c2t1LzEyMw`. 2. **Plain Format**: The `{productinput}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{productinput}` segment is used to differentiate between the two formats. "offerId": "A String", # Required. Immutable. Your unique identifier for the product. This is the same for the product input and processed product. Leading and trailing whitespaces are stripped and multiple whitespaces are replaced by a single whitespace upon submission. See the [products data specification](https://support.google.com/merchants/answer/188494#id) for details. "product": "A String", # Output only. The name of the processed product. Format: `accounts/{account}/products/{product}` "versionNumber": "A String", # Optional. Immutable. Represents the existing version (freshness) of the product, which can be used to preserve the right order when multiple updates are done at the same time. If set, the insertion is prevented when version number is lower than the current version number of the existing product. Re-insertion (for example, product refresh after 30 days) can be performed with the current `version_number`. Only supported for insertions into primary data sources. Do not set this field for updates. Do not set this field for insertions into supplemental data sources. If the operation is prevented, the aborted exception will be thrown. @@ -747,7 +747,7 @@

Method Details

}, ], "feedLabel": "A String", # Required. Immutable. The feed label that lets you categorize and identify your products. The maximum allowed characters are 20, and the supported characters are `A-Z`, `0-9`, hyphen, and underscore. The feed label must not include any spaces. For more information, see [Using feed labels](//support.google.com/merchants/answer/14994087). - "name": "A String", # Identifier. The name of the product. Format: `accounts/{account}/productInputs/{productinput}` The {productinput} segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the {productinput} segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{productinput}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{productinput}` segment must be the base64url encoding of this string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name for the product would be `accounts/123/productinputs/ZW5-VVMtc2t1LzEyMw`. 2. **Plain Format**: The `{productinput}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{productinput}` segment is used to differentiate between the two formats. Note: For calls to the v1beta version, the plain format is `channel~content_language~feed_label~offer_id`, for example: `accounts/123/productinputs/online~en~US~sku123`. + "name": "A String", # Identifier. The name of the product. Format: `accounts/{account}/productInputs/{productinput}` The {productinput} segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the {productinput} segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{productinput}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{productinput}` segment must be the base64url encoding of this string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name for the product would be `accounts/123/productInputs/ZW5-VVN-c2t1LzEyMw`. 2. **Plain Format**: The `{productinput}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{productinput}` segment is used to differentiate between the two formats. "offerId": "A String", # Required. Immutable. Your unique identifier for the product. This is the same for the product input and processed product. Leading and trailing whitespaces are stripped and multiple whitespaces are replaced by a single whitespace upon submission. See the [products data specification](https://support.google.com/merchants/answer/188494#id) for details. "product": "A String", # Output only. The name of the processed product. Format: `accounts/{account}/products/{product}` "versionNumber": "A String", # Optional. Immutable. Represents the existing version (freshness) of the product, which can be used to preserve the right order when multiple updates are done at the same time. If set, the insertion is prevented when version number is lower than the current version number of the existing product. Re-insertion (for example, product refresh after 30 days) can be performed with the current `version_number`. Only supported for insertions into primary data sources. Do not set this field for updates. Do not set this field for insertions into supplemental data sources. If the operation is prevented, the aborted exception will be thrown. @@ -759,7 +759,7 @@

Method Details

Updates the existing product input in your Merchant Center account. The name of the product input to update is taken from the `name` field within the `ProductInput` resource. After inserting, updating, or deleting a product input, it may take several minutes before the processed product can be retrieved.
 
 Args:
-  name: string, Identifier. The name of the product. Format: `accounts/{account}/productInputs/{productinput}` The {productinput} segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the {productinput} segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{productinput}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{productinput}` segment must be the base64url encoding of this string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name for the product would be `accounts/123/productinputs/ZW5-VVMtc2t1LzEyMw`. 2. **Plain Format**: The `{productinput}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{productinput}` segment is used to differentiate between the two formats. Note: For calls to the v1beta version, the plain format is `channel~content_language~feed_label~offer_id`, for example: `accounts/123/productinputs/online~en~US~sku123`. (required)
+  name: string, Identifier. The name of the product. Format: `accounts/{account}/productInputs/{productinput}` The {productinput} segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the {productinput} segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{productinput}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{productinput}` segment must be the base64url encoding of this string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name for the product would be `accounts/123/productInputs/ZW5-VVN-c2t1LzEyMw`. 2. **Plain Format**: The `{productinput}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{productinput}` segment is used to differentiate between the two formats. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -1069,7 +1069,7 @@ 

Method Details

}, ], "feedLabel": "A String", # Required. Immutable. The feed label that lets you categorize and identify your products. The maximum allowed characters are 20, and the supported characters are `A-Z`, `0-9`, hyphen, and underscore. The feed label must not include any spaces. For more information, see [Using feed labels](//support.google.com/merchants/answer/14994087). - "name": "A String", # Identifier. The name of the product. Format: `accounts/{account}/productInputs/{productinput}` The {productinput} segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the {productinput} segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{productinput}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{productinput}` segment must be the base64url encoding of this string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name for the product would be `accounts/123/productinputs/ZW5-VVMtc2t1LzEyMw`. 2. **Plain Format**: The `{productinput}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{productinput}` segment is used to differentiate between the two formats. Note: For calls to the v1beta version, the plain format is `channel~content_language~feed_label~offer_id`, for example: `accounts/123/productinputs/online~en~US~sku123`. + "name": "A String", # Identifier. The name of the product. Format: `accounts/{account}/productInputs/{productinput}` The {productinput} segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the {productinput} segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{productinput}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{productinput}` segment must be the base64url encoding of this string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name for the product would be `accounts/123/productInputs/ZW5-VVN-c2t1LzEyMw`. 2. **Plain Format**: The `{productinput}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{productinput}` segment is used to differentiate between the two formats. "offerId": "A String", # Required. Immutable. Your unique identifier for the product. This is the same for the product input and processed product. Leading and trailing whitespaces are stripped and multiple whitespaces are replaced by a single whitespace upon submission. See the [products data specification](https://support.google.com/merchants/answer/188494#id) for details. "product": "A String", # Output only. The name of the processed product. Format: `accounts/{account}/products/{product}` "versionNumber": "A String", # Optional. Immutable. Represents the existing version (freshness) of the product, which can be used to preserve the right order when multiple updates are done at the same time. If set, the insertion is prevented when version number is lower than the current version number of the existing product. Re-insertion (for example, product refresh after 30 days) can be performed with the current `version_number`. Only supported for insertions into primary data sources. Do not set this field for updates. Do not set this field for insertions into supplemental data sources. If the operation is prevented, the aborted exception will be thrown. @@ -1391,7 +1391,7 @@

Method Details

}, ], "feedLabel": "A String", # Required. Immutable. The feed label that lets you categorize and identify your products. The maximum allowed characters are 20, and the supported characters are `A-Z`, `0-9`, hyphen, and underscore. The feed label must not include any spaces. For more information, see [Using feed labels](//support.google.com/merchants/answer/14994087). - "name": "A String", # Identifier. The name of the product. Format: `accounts/{account}/productInputs/{productinput}` The {productinput} segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the {productinput} segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{productinput}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{productinput}` segment must be the base64url encoding of this string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name for the product would be `accounts/123/productinputs/ZW5-VVMtc2t1LzEyMw`. 2. **Plain Format**: The `{productinput}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{productinput}` segment is used to differentiate between the two formats. Note: For calls to the v1beta version, the plain format is `channel~content_language~feed_label~offer_id`, for example: `accounts/123/productinputs/online~en~US~sku123`. + "name": "A String", # Identifier. The name of the product. Format: `accounts/{account}/productInputs/{productinput}` The {productinput} segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the {productinput} segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{productinput}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{productinput}` segment must be the base64url encoding of this string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name for the product would be `accounts/123/productInputs/ZW5-VVN-c2t1LzEyMw`. 2. **Plain Format**: The `{productinput}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{productinput}` segment is used to differentiate between the two formats. "offerId": "A String", # Required. Immutable. Your unique identifier for the product. This is the same for the product input and processed product. Leading and trailing whitespaces are stripped and multiple whitespaces are replaced by a single whitespace upon submission. See the [products data specification](https://support.google.com/merchants/answer/188494#id) for details. "product": "A String", # Output only. The name of the processed product. Format: `accounts/{account}/products/{product}` "versionNumber": "A String", # Optional. Immutable. Represents the existing version (freshness) of the product, which can be used to preserve the right order when multiple updates are done at the same time. If set, the insertion is prevented when version number is lower than the current version number of the existing product. Re-insertion (for example, product refresh after 30 days) can be performed with the current `version_number`. Only supported for insertions into primary data sources. Do not set this field for updates. Do not set this field for insertions into supplemental data sources. If the operation is prevented, the aborted exception will be thrown. diff --git a/docs/dyn/migrationcenter_v1.projects.locations.html b/docs/dyn/migrationcenter_v1.projects.locations.html index 1869cedd00..15e6665012 100644 --- a/docs/dyn/migrationcenter_v1.projects.locations.html +++ b/docs/dyn/migrationcenter_v1.projects.locations.html @@ -135,7 +135,7 @@

Instance Methods

Gets the details of regional settings.

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

-

Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.

+

Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.

list_next()

Retrieves the next page of results.

@@ -198,7 +198,7 @@

Method Details

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
+  
Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
diff --git a/docs/dyn/mybusinessbusinessinformation_v1.accounts.locations.html b/docs/dyn/mybusinessbusinessinformation_v1.accounts.locations.html
index 92a09e6114..2e6bbc493c 100644
--- a/docs/dyn/mybusinessbusinessinformation_v1.accounts.locations.html
+++ b/docs/dyn/mybusinessbusinessinformation_v1.accounts.locations.html
@@ -160,7 +160,7 @@ 

Method Details

"canOperateLocalPost": True or False, # Output only. Indicates if the listing can manage local posts. Deprecated: This field is no longer populated and will be removed in a future version. "canOperateLodgingData": True or False, # Output only. Indicates whether the location can operate on Lodging data. "duplicateLocation": "A String", # Output only. The location resource that this location duplicates. - "hasGoogleUpdated": True or False, # Output only. Indicates whether the place ID associated with this location has updates that need to be updated or rejected by the client. If this boolean is set, you should call the `getGoogleUpdated` method to lookup information that's needs to be verified. + "hasGoogleUpdated": True or False, # Output only. Indicates whether the place ID associated with this location has updates that need to be updated or rejected by the client. If this boolean is set, you should call the `getGoogleUpdated` method to look up information that's needs to be verified. "hasPendingEdits": True or False, # Output only. Indicates whether any of this Location's properties are in the edit pending state. "hasVoiceOfMerchant": True or False, # Output only. Indicates if the listing has Voice of Merchant. If this boolean is false, you should call the locations.getVoiceOfMerchantState API to get details as to why they do not have Voice of Merchant. "isParticularlyPersonalPlace": True or False, # Output only. @@ -257,9 +257,9 @@

Method Details

}, "serviceItems": [ # Optional. List of services supported by merchants. A service can be haircut, install water heater, etc. Duplicated service items will be removed automatically. { # A message that describes a single service item. It is used to describe the type of service that the merchant provides. For example, haircut can be a service. - "freeFormServiceItem": { # Represents a free-form service offered by the merchant. These are services that are not exposed as part of our structure service data. The merchant manually enters the names for of such services via a geomerchant surface. # Optional. This field will be set case of free-form services data. + "freeFormServiceItem": { # Represents a free-form service offered by the merchant. These are services that are not exposed as part of our structure service data. The merchant manually enters the names for such services using a geomerchant surface. # Optional. This field will be set case of free-form services data. "category": "A String", # Required. This field represents the category name (i.e. the category's stable ID). The `category` and `service_type_id` should match the possible combinations provided in the `Category` message. - "label": { # Label to be used when displaying the price list, section, or item. # Required. Language-tagged labels for the item. We recommend that item names be 140 characters or less, and descriptions 250 characters or less. This field should only be set if the input is a custom service item. Standardized service types should be updated via service_type_id. + "label": { # Label to be used when displaying the price list, section, or item. # Required. Language-tagged labels for the item. We recommend that item names be 140 characters or less, and descriptions 250 characters or less. This field should only be set if the input is a custom service item. Standardized service types should be updated using service_type_id. "description": "A String", # Optional. Description of the price list, section, or item. "displayName": "A String", # Required. Display name for the price list, section, or item. "languageCode": "A String", # Optional. The BCP-47 language code that these strings apply for. Only one set of labels may be set per language. @@ -396,7 +396,7 @@

Method Details

"canOperateLocalPost": True or False, # Output only. Indicates if the listing can manage local posts. Deprecated: This field is no longer populated and will be removed in a future version. "canOperateLodgingData": True or False, # Output only. Indicates whether the location can operate on Lodging data. "duplicateLocation": "A String", # Output only. The location resource that this location duplicates. - "hasGoogleUpdated": True or False, # Output only. Indicates whether the place ID associated with this location has updates that need to be updated or rejected by the client. If this boolean is set, you should call the `getGoogleUpdated` method to lookup information that's needs to be verified. + "hasGoogleUpdated": True or False, # Output only. Indicates whether the place ID associated with this location has updates that need to be updated or rejected by the client. If this boolean is set, you should call the `getGoogleUpdated` method to look up information that's needs to be verified. "hasPendingEdits": True or False, # Output only. Indicates whether any of this Location's properties are in the edit pending state. "hasVoiceOfMerchant": True or False, # Output only. Indicates if the listing has Voice of Merchant. If this boolean is false, you should call the locations.getVoiceOfMerchantState API to get details as to why they do not have Voice of Merchant. "isParticularlyPersonalPlace": True or False, # Output only. @@ -493,9 +493,9 @@

Method Details

}, "serviceItems": [ # Optional. List of services supported by merchants. A service can be haircut, install water heater, etc. Duplicated service items will be removed automatically. { # A message that describes a single service item. It is used to describe the type of service that the merchant provides. For example, haircut can be a service. - "freeFormServiceItem": { # Represents a free-form service offered by the merchant. These are services that are not exposed as part of our structure service data. The merchant manually enters the names for of such services via a geomerchant surface. # Optional. This field will be set case of free-form services data. + "freeFormServiceItem": { # Represents a free-form service offered by the merchant. These are services that are not exposed as part of our structure service data. The merchant manually enters the names for such services using a geomerchant surface. # Optional. This field will be set case of free-form services data. "category": "A String", # Required. This field represents the category name (i.e. the category's stable ID). The `category` and `service_type_id` should match the possible combinations provided in the `Category` message. - "label": { # Label to be used when displaying the price list, section, or item. # Required. Language-tagged labels for the item. We recommend that item names be 140 characters or less, and descriptions 250 characters or less. This field should only be set if the input is a custom service item. Standardized service types should be updated via service_type_id. + "label": { # Label to be used when displaying the price list, section, or item. # Required. Language-tagged labels for the item. We recommend that item names be 140 characters or less, and descriptions 250 characters or less. This field should only be set if the input is a custom service item. Standardized service types should be updated using service_type_id. "description": "A String", # Optional. Description of the price list, section, or item. "displayName": "A String", # Required. Display name for the price list, section, or item. "languageCode": "A String", # Optional. The BCP-47 language code that these strings apply for. Only one set of labels may be set per language. @@ -644,7 +644,7 @@

Method Details

"canOperateLocalPost": True or False, # Output only. Indicates if the listing can manage local posts. Deprecated: This field is no longer populated and will be removed in a future version. "canOperateLodgingData": True or False, # Output only. Indicates whether the location can operate on Lodging data. "duplicateLocation": "A String", # Output only. The location resource that this location duplicates. - "hasGoogleUpdated": True or False, # Output only. Indicates whether the place ID associated with this location has updates that need to be updated or rejected by the client. If this boolean is set, you should call the `getGoogleUpdated` method to lookup information that's needs to be verified. + "hasGoogleUpdated": True or False, # Output only. Indicates whether the place ID associated with this location has updates that need to be updated or rejected by the client. If this boolean is set, you should call the `getGoogleUpdated` method to look up information that's needs to be verified. "hasPendingEdits": True or False, # Output only. Indicates whether any of this Location's properties are in the edit pending state. "hasVoiceOfMerchant": True or False, # Output only. Indicates if the listing has Voice of Merchant. If this boolean is false, you should call the locations.getVoiceOfMerchantState API to get details as to why they do not have Voice of Merchant. "isParticularlyPersonalPlace": True or False, # Output only. @@ -741,9 +741,9 @@

Method Details

}, "serviceItems": [ # Optional. List of services supported by merchants. A service can be haircut, install water heater, etc. Duplicated service items will be removed automatically. { # A message that describes a single service item. It is used to describe the type of service that the merchant provides. For example, haircut can be a service. - "freeFormServiceItem": { # Represents a free-form service offered by the merchant. These are services that are not exposed as part of our structure service data. The merchant manually enters the names for of such services via a geomerchant surface. # Optional. This field will be set case of free-form services data. + "freeFormServiceItem": { # Represents a free-form service offered by the merchant. These are services that are not exposed as part of our structure service data. The merchant manually enters the names for such services using a geomerchant surface. # Optional. This field will be set case of free-form services data. "category": "A String", # Required. This field represents the category name (i.e. the category's stable ID). The `category` and `service_type_id` should match the possible combinations provided in the `Category` message. - "label": { # Label to be used when displaying the price list, section, or item. # Required. Language-tagged labels for the item. We recommend that item names be 140 characters or less, and descriptions 250 characters or less. This field should only be set if the input is a custom service item. Standardized service types should be updated via service_type_id. + "label": { # Label to be used when displaying the price list, section, or item. # Required. Language-tagged labels for the item. We recommend that item names be 140 characters or less, and descriptions 250 characters or less. This field should only be set if the input is a custom service item. Standardized service types should be updated using service_type_id. "description": "A String", # Optional. Description of the price list, section, or item. "displayName": "A String", # Required. Display name for the price list, section, or item. "languageCode": "A String", # Optional. The BCP-47 language code that these strings apply for. Only one set of labels may be set per language. diff --git a/docs/dyn/mybusinessbusinessinformation_v1.googleLocations.html b/docs/dyn/mybusinessbusinessinformation_v1.googleLocations.html index 09e4a9817f..e490d42522 100644 --- a/docs/dyn/mybusinessbusinessinformation_v1.googleLocations.html +++ b/docs/dyn/mybusinessbusinessinformation_v1.googleLocations.html @@ -154,7 +154,7 @@

Method Details

"canOperateLocalPost": True or False, # Output only. Indicates if the listing can manage local posts. Deprecated: This field is no longer populated and will be removed in a future version. "canOperateLodgingData": True or False, # Output only. Indicates whether the location can operate on Lodging data. "duplicateLocation": "A String", # Output only. The location resource that this location duplicates. - "hasGoogleUpdated": True or False, # Output only. Indicates whether the place ID associated with this location has updates that need to be updated or rejected by the client. If this boolean is set, you should call the `getGoogleUpdated` method to lookup information that's needs to be verified. + "hasGoogleUpdated": True or False, # Output only. Indicates whether the place ID associated with this location has updates that need to be updated or rejected by the client. If this boolean is set, you should call the `getGoogleUpdated` method to look up information that's needs to be verified. "hasPendingEdits": True or False, # Output only. Indicates whether any of this Location's properties are in the edit pending state. "hasVoiceOfMerchant": True or False, # Output only. Indicates if the listing has Voice of Merchant. If this boolean is false, you should call the locations.getVoiceOfMerchantState API to get details as to why they do not have Voice of Merchant. "isParticularlyPersonalPlace": True or False, # Output only. @@ -251,9 +251,9 @@

Method Details

}, "serviceItems": [ # Optional. List of services supported by merchants. A service can be haircut, install water heater, etc. Duplicated service items will be removed automatically. { # A message that describes a single service item. It is used to describe the type of service that the merchant provides. For example, haircut can be a service. - "freeFormServiceItem": { # Represents a free-form service offered by the merchant. These are services that are not exposed as part of our structure service data. The merchant manually enters the names for of such services via a geomerchant surface. # Optional. This field will be set case of free-form services data. + "freeFormServiceItem": { # Represents a free-form service offered by the merchant. These are services that are not exposed as part of our structure service data. The merchant manually enters the names for such services using a geomerchant surface. # Optional. This field will be set case of free-form services data. "category": "A String", # Required. This field represents the category name (i.e. the category's stable ID). The `category` and `service_type_id` should match the possible combinations provided in the `Category` message. - "label": { # Label to be used when displaying the price list, section, or item. # Required. Language-tagged labels for the item. We recommend that item names be 140 characters or less, and descriptions 250 characters or less. This field should only be set if the input is a custom service item. Standardized service types should be updated via service_type_id. + "label": { # Label to be used when displaying the price list, section, or item. # Required. Language-tagged labels for the item. We recommend that item names be 140 characters or less, and descriptions 250 characters or less. This field should only be set if the input is a custom service item. Standardized service types should be updated using service_type_id. "description": "A String", # Optional. Description of the price list, section, or item. "displayName": "A String", # Required. Display name for the price list, section, or item. "languageCode": "A String", # Optional. The BCP-47 language code that these strings apply for. Only one set of labels may be set per language. @@ -394,7 +394,7 @@

Method Details

"canOperateLocalPost": True or False, # Output only. Indicates if the listing can manage local posts. Deprecated: This field is no longer populated and will be removed in a future version. "canOperateLodgingData": True or False, # Output only. Indicates whether the location can operate on Lodging data. "duplicateLocation": "A String", # Output only. The location resource that this location duplicates. - "hasGoogleUpdated": True or False, # Output only. Indicates whether the place ID associated with this location has updates that need to be updated or rejected by the client. If this boolean is set, you should call the `getGoogleUpdated` method to lookup information that's needs to be verified. + "hasGoogleUpdated": True or False, # Output only. Indicates whether the place ID associated with this location has updates that need to be updated or rejected by the client. If this boolean is set, you should call the `getGoogleUpdated` method to look up information that's needs to be verified. "hasPendingEdits": True or False, # Output only. Indicates whether any of this Location's properties are in the edit pending state. "hasVoiceOfMerchant": True or False, # Output only. Indicates if the listing has Voice of Merchant. If this boolean is false, you should call the locations.getVoiceOfMerchantState API to get details as to why they do not have Voice of Merchant. "isParticularlyPersonalPlace": True or False, # Output only. @@ -491,9 +491,9 @@

Method Details

}, "serviceItems": [ # Optional. List of services supported by merchants. A service can be haircut, install water heater, etc. Duplicated service items will be removed automatically. { # A message that describes a single service item. It is used to describe the type of service that the merchant provides. For example, haircut can be a service. - "freeFormServiceItem": { # Represents a free-form service offered by the merchant. These are services that are not exposed as part of our structure service data. The merchant manually enters the names for of such services via a geomerchant surface. # Optional. This field will be set case of free-form services data. + "freeFormServiceItem": { # Represents a free-form service offered by the merchant. These are services that are not exposed as part of our structure service data. The merchant manually enters the names for such services using a geomerchant surface. # Optional. This field will be set case of free-form services data. "category": "A String", # Required. This field represents the category name (i.e. the category's stable ID). The `category` and `service_type_id` should match the possible combinations provided in the `Category` message. - "label": { # Label to be used when displaying the price list, section, or item. # Required. Language-tagged labels for the item. We recommend that item names be 140 characters or less, and descriptions 250 characters or less. This field should only be set if the input is a custom service item. Standardized service types should be updated via service_type_id. + "label": { # Label to be used when displaying the price list, section, or item. # Required. Language-tagged labels for the item. We recommend that item names be 140 characters or less, and descriptions 250 characters or less. This field should only be set if the input is a custom service item. Standardized service types should be updated using service_type_id. "description": "A String", # Optional. Description of the price list, section, or item. "displayName": "A String", # Required. Display name for the price list, section, or item. "languageCode": "A String", # Optional. The BCP-47 language code that these strings apply for. Only one set of labels may be set per language. diff --git a/docs/dyn/mybusinessbusinessinformation_v1.locations.attributes.html b/docs/dyn/mybusinessbusinessinformation_v1.locations.attributes.html index c58182159f..c32806b090 100644 --- a/docs/dyn/mybusinessbusinessinformation_v1.locations.attributes.html +++ b/docs/dyn/mybusinessbusinessinformation_v1.locations.attributes.html @@ -79,7 +79,7 @@

Instance Methods

Close httplib2 connections.

getGoogleUpdated(name, x__xgafv=None)

-

Gets the Google-updated version of the specified location.

+

Gets the version of the specified location, returning an `Attributes` message that provides the attributes view as it appears to consumers, which may be different than the merchant's information.

Method Details

close() @@ -88,7 +88,7 @@

Method Details

getGoogleUpdated(name, x__xgafv=None) -
Gets the Google-updated version of the specified location.
+  
Gets the version of the specified location, returning an `Attributes` message that provides the attributes view as it appears to consumers, which may be different than the merchant's information.
 
 Args:
   name: string, Required. Google identifier for this location in the form of `locations/{location_id}/attributes`. (required)
diff --git a/docs/dyn/mybusinessbusinessinformation_v1.locations.html b/docs/dyn/mybusinessbusinessinformation_v1.locations.html
index f4c78e214d..85c57b5e52 100644
--- a/docs/dyn/mybusinessbusinessinformation_v1.locations.html
+++ b/docs/dyn/mybusinessbusinessinformation_v1.locations.html
@@ -93,7 +93,7 @@ 

Instance Methods

Looks up all the attributes set for a given location.

getGoogleUpdated(name, readMask=None, x__xgafv=None)

-

Gets the Google-updated version of the specified location.

+

Gets the version of the specified location, returning a `GoogleUpdatedLocation` that provides the location view as it appears to consumers and masks indicating which fields are different than the merchant's information.

patch(name, body=None, updateMask=None, validateOnly=None, x__xgafv=None)

Updates the specified location.

@@ -198,7 +198,7 @@

Method Details

"canOperateLocalPost": True or False, # Output only. Indicates if the listing can manage local posts. Deprecated: This field is no longer populated and will be removed in a future version. "canOperateLodgingData": True or False, # Output only. Indicates whether the location can operate on Lodging data. "duplicateLocation": "A String", # Output only. The location resource that this location duplicates. - "hasGoogleUpdated": True or False, # Output only. Indicates whether the place ID associated with this location has updates that need to be updated or rejected by the client. If this boolean is set, you should call the `getGoogleUpdated` method to lookup information that's needs to be verified. + "hasGoogleUpdated": True or False, # Output only. Indicates whether the place ID associated with this location has updates that need to be updated or rejected by the client. If this boolean is set, you should call the `getGoogleUpdated` method to look up information that's needs to be verified. "hasPendingEdits": True or False, # Output only. Indicates whether any of this Location's properties are in the edit pending state. "hasVoiceOfMerchant": True or False, # Output only. Indicates if the listing has Voice of Merchant. If this boolean is false, you should call the locations.getVoiceOfMerchantState API to get details as to why they do not have Voice of Merchant. "isParticularlyPersonalPlace": True or False, # Output only. @@ -295,9 +295,9 @@

Method Details

}, "serviceItems": [ # Optional. List of services supported by merchants. A service can be haircut, install water heater, etc. Duplicated service items will be removed automatically. { # A message that describes a single service item. It is used to describe the type of service that the merchant provides. For example, haircut can be a service. - "freeFormServiceItem": { # Represents a free-form service offered by the merchant. These are services that are not exposed as part of our structure service data. The merchant manually enters the names for of such services via a geomerchant surface. # Optional. This field will be set case of free-form services data. + "freeFormServiceItem": { # Represents a free-form service offered by the merchant. These are services that are not exposed as part of our structure service data. The merchant manually enters the names for such services using a geomerchant surface. # Optional. This field will be set case of free-form services data. "category": "A String", # Required. This field represents the category name (i.e. the category's stable ID). The `category` and `service_type_id` should match the possible combinations provided in the `Category` message. - "label": { # Label to be used when displaying the price list, section, or item. # Required. Language-tagged labels for the item. We recommend that item names be 140 characters or less, and descriptions 250 characters or less. This field should only be set if the input is a custom service item. Standardized service types should be updated via service_type_id. + "label": { # Label to be used when displaying the price list, section, or item. # Required. Language-tagged labels for the item. We recommend that item names be 140 characters or less, and descriptions 250 characters or less. This field should only be set if the input is a custom service item. Standardized service types should be updated using service_type_id. "description": "A String", # Optional. Description of the price list, section, or item. "displayName": "A String", # Required. Display name for the price list, section, or item. "languageCode": "A String", # Optional. The BCP-47 language code that these strings apply for. Only one set of labels may be set per language. @@ -409,7 +409,7 @@

Method Details

getGoogleUpdated(name, readMask=None, x__xgafv=None) -
Gets the Google-updated version of the specified location.
+  
Gets the version of the specified location, returning a `GoogleUpdatedLocation` that provides the location view as it appears to consumers and masks indicating which fields are different than the merchant's information.
 
 Args:
   name: string, Required. The name of the location to fetch. (required)
@@ -422,8 +422,8 @@ 

Method Details

Returns: An object of the form: - { # Represents a location that was modified by Google. - "diffMask": "A String", # The fields that Google updated. + { # Represents the view of a location as it appears to consumers, which includes updates that are currently serving on Google Maps and Search. + "diffMask": "A String", # The fields where the values in the view as it appears to consumers are different than the merchant's information. To accept these changes, patch the location. To reject, patch with your preferred values. "location": { # A location. See the [help center article] (https://support.google.com/business/answer/3038177) for a detailed description of these fields, or the [category endpoint](/my-business/reference/rest/v4/categories) for a list of valid business categories. # The Google-updated version of this location. "adWordsLocationExtensions": { # Additional information that is surfaced in AdWords. # Optional. Additional information that is surfaced in AdWords. "adPhone": "A String", # Required. An alternate phone number to display on AdWords location extensions instead of the location's primary phone number. @@ -483,7 +483,7 @@

Method Details

"canOperateLocalPost": True or False, # Output only. Indicates if the listing can manage local posts. Deprecated: This field is no longer populated and will be removed in a future version. "canOperateLodgingData": True or False, # Output only. Indicates whether the location can operate on Lodging data. "duplicateLocation": "A String", # Output only. The location resource that this location duplicates. - "hasGoogleUpdated": True or False, # Output only. Indicates whether the place ID associated with this location has updates that need to be updated or rejected by the client. If this boolean is set, you should call the `getGoogleUpdated` method to lookup information that's needs to be verified. + "hasGoogleUpdated": True or False, # Output only. Indicates whether the place ID associated with this location has updates that need to be updated or rejected by the client. If this boolean is set, you should call the `getGoogleUpdated` method to look up information that's needs to be verified. "hasPendingEdits": True or False, # Output only. Indicates whether any of this Location's properties are in the edit pending state. "hasVoiceOfMerchant": True or False, # Output only. Indicates if the listing has Voice of Merchant. If this boolean is false, you should call the locations.getVoiceOfMerchantState API to get details as to why they do not have Voice of Merchant. "isParticularlyPersonalPlace": True or False, # Output only. @@ -580,9 +580,9 @@

Method Details

}, "serviceItems": [ # Optional. List of services supported by merchants. A service can be haircut, install water heater, etc. Duplicated service items will be removed automatically. { # A message that describes a single service item. It is used to describe the type of service that the merchant provides. For example, haircut can be a service. - "freeFormServiceItem": { # Represents a free-form service offered by the merchant. These are services that are not exposed as part of our structure service data. The merchant manually enters the names for of such services via a geomerchant surface. # Optional. This field will be set case of free-form services data. + "freeFormServiceItem": { # Represents a free-form service offered by the merchant. These are services that are not exposed as part of our structure service data. The merchant manually enters the names for such services using a geomerchant surface. # Optional. This field will be set case of free-form services data. "category": "A String", # Required. This field represents the category name (i.e. the category's stable ID). The `category` and `service_type_id` should match the possible combinations provided in the `Category` message. - "label": { # Label to be used when displaying the price list, section, or item. # Required. Language-tagged labels for the item. We recommend that item names be 140 characters or less, and descriptions 250 characters or less. This field should only be set if the input is a custom service item. Standardized service types should be updated via service_type_id. + "label": { # Label to be used when displaying the price list, section, or item. # Required. Language-tagged labels for the item. We recommend that item names be 140 characters or less, and descriptions 250 characters or less. This field should only be set if the input is a custom service item. Standardized service types should be updated using service_type_id. "description": "A String", # Optional. Description of the price list, section, or item. "displayName": "A String", # Required. Display name for the price list, section, or item. "languageCode": "A String", # Optional. The BCP-47 language code that these strings apply for. Only one set of labels may be set per language. @@ -649,7 +649,7 @@

Method Details

"title": "A String", # Required. Location name should reflect your business's real-world name, as used consistently on your storefront, website, and stationery, and as known to customers. Any additional information, when relevant, can be included in other fields of the resource (for example, `Address`, `Categories`). Don't add unnecessary information to your name (for example, prefer "Google" over "Google Inc. - Mountain View Corporate Headquarters"). Don't include marketing taglines, store codes, special characters, hours or closed/open status, phone numbers, website URLs, service/product information, location/address or directions, or containment information (for example, "Chase ATM in Duane Reade"). "websiteUri": "A String", # Optional. A URL for this business. If possible, use a URL that represents this individual business location instead of a generic website/URL that represents all locations, or the brand. }, - "pendingMask": "A String", # The fields that have pending edits that haven't yet been pushed to Maps and Search. + "pendingMask": "A String", # The fields where the merchant has provided an update that is currently in flight and hasn't yet been published to Maps and Search. This mask only tracks the status of the merchant's own edits, not external changes. }
@@ -721,7 +721,7 @@

Method Details

"canOperateLocalPost": True or False, # Output only. Indicates if the listing can manage local posts. Deprecated: This field is no longer populated and will be removed in a future version. "canOperateLodgingData": True or False, # Output only. Indicates whether the location can operate on Lodging data. "duplicateLocation": "A String", # Output only. The location resource that this location duplicates. - "hasGoogleUpdated": True or False, # Output only. Indicates whether the place ID associated with this location has updates that need to be updated or rejected by the client. If this boolean is set, you should call the `getGoogleUpdated` method to lookup information that's needs to be verified. + "hasGoogleUpdated": True or False, # Output only. Indicates whether the place ID associated with this location has updates that need to be updated or rejected by the client. If this boolean is set, you should call the `getGoogleUpdated` method to look up information that's needs to be verified. "hasPendingEdits": True or False, # Output only. Indicates whether any of this Location's properties are in the edit pending state. "hasVoiceOfMerchant": True or False, # Output only. Indicates if the listing has Voice of Merchant. If this boolean is false, you should call the locations.getVoiceOfMerchantState API to get details as to why they do not have Voice of Merchant. "isParticularlyPersonalPlace": True or False, # Output only. @@ -818,9 +818,9 @@

Method Details

}, "serviceItems": [ # Optional. List of services supported by merchants. A service can be haircut, install water heater, etc. Duplicated service items will be removed automatically. { # A message that describes a single service item. It is used to describe the type of service that the merchant provides. For example, haircut can be a service. - "freeFormServiceItem": { # Represents a free-form service offered by the merchant. These are services that are not exposed as part of our structure service data. The merchant manually enters the names for of such services via a geomerchant surface. # Optional. This field will be set case of free-form services data. + "freeFormServiceItem": { # Represents a free-form service offered by the merchant. These are services that are not exposed as part of our structure service data. The merchant manually enters the names for such services using a geomerchant surface. # Optional. This field will be set case of free-form services data. "category": "A String", # Required. This field represents the category name (i.e. the category's stable ID). The `category` and `service_type_id` should match the possible combinations provided in the `Category` message. - "label": { # Label to be used when displaying the price list, section, or item. # Required. Language-tagged labels for the item. We recommend that item names be 140 characters or less, and descriptions 250 characters or less. This field should only be set if the input is a custom service item. Standardized service types should be updated via service_type_id. + "label": { # Label to be used when displaying the price list, section, or item. # Required. Language-tagged labels for the item. We recommend that item names be 140 characters or less, and descriptions 250 characters or less. This field should only be set if the input is a custom service item. Standardized service types should be updated using service_type_id. "description": "A String", # Optional. Description of the price list, section, or item. "displayName": "A String", # Required. Display name for the price list, section, or item. "languageCode": "A String", # Optional. The BCP-47 language code that these strings apply for. Only one set of labels may be set per language. @@ -957,7 +957,7 @@

Method Details

"canOperateLocalPost": True or False, # Output only. Indicates if the listing can manage local posts. Deprecated: This field is no longer populated and will be removed in a future version. "canOperateLodgingData": True or False, # Output only. Indicates whether the location can operate on Lodging data. "duplicateLocation": "A String", # Output only. The location resource that this location duplicates. - "hasGoogleUpdated": True or False, # Output only. Indicates whether the place ID associated with this location has updates that need to be updated or rejected by the client. If this boolean is set, you should call the `getGoogleUpdated` method to lookup information that's needs to be verified. + "hasGoogleUpdated": True or False, # Output only. Indicates whether the place ID associated with this location has updates that need to be updated or rejected by the client. If this boolean is set, you should call the `getGoogleUpdated` method to look up information that's needs to be verified. "hasPendingEdits": True or False, # Output only. Indicates whether any of this Location's properties are in the edit pending state. "hasVoiceOfMerchant": True or False, # Output only. Indicates if the listing has Voice of Merchant. If this boolean is false, you should call the locations.getVoiceOfMerchantState API to get details as to why they do not have Voice of Merchant. "isParticularlyPersonalPlace": True or False, # Output only. @@ -1054,9 +1054,9 @@

Method Details

}, "serviceItems": [ # Optional. List of services supported by merchants. A service can be haircut, install water heater, etc. Duplicated service items will be removed automatically. { # A message that describes a single service item. It is used to describe the type of service that the merchant provides. For example, haircut can be a service. - "freeFormServiceItem": { # Represents a free-form service offered by the merchant. These are services that are not exposed as part of our structure service data. The merchant manually enters the names for of such services via a geomerchant surface. # Optional. This field will be set case of free-form services data. + "freeFormServiceItem": { # Represents a free-form service offered by the merchant. These are services that are not exposed as part of our structure service data. The merchant manually enters the names for such services using a geomerchant surface. # Optional. This field will be set case of free-form services data. "category": "A String", # Required. This field represents the category name (i.e. the category's stable ID). The `category` and `service_type_id` should match the possible combinations provided in the `Category` message. - "label": { # Label to be used when displaying the price list, section, or item. # Required. Language-tagged labels for the item. We recommend that item names be 140 characters or less, and descriptions 250 characters or less. This field should only be set if the input is a custom service item. Standardized service types should be updated via service_type_id. + "label": { # Label to be used when displaying the price list, section, or item. # Required. Language-tagged labels for the item. We recommend that item names be 140 characters or less, and descriptions 250 characters or less. This field should only be set if the input is a custom service item. Standardized service types should be updated using service_type_id. "description": "A String", # Optional. Description of the price list, section, or item. "displayName": "A String", # Required. Display name for the price list, section, or item. "languageCode": "A String", # Optional. The BCP-47 language code that these strings apply for. Only one set of labels may be set per language. diff --git a/docs/dyn/netapp_v1.projects.locations.storagePools.html b/docs/dyn/netapp_v1.projects.locations.storagePools.html index 59bc48d535..996a58c10e 100644 --- a/docs/dyn/netapp_v1.projects.locations.storagePools.html +++ b/docs/dyn/netapp_v1.projects.locations.storagePools.html @@ -148,6 +148,7 @@

Method Details

"replicaZone": "A String", # Optional. Specifies the replica zone for regional storagePool. "satisfiesPzi": True or False, # Output only. Reserved for future use "satisfiesPzs": True or False, # Output only. Reserved for future use + "scaleType": "A String", # Optional. The scale type of the storage pool. Defaults to `SCALE_TYPE_DEFAULT` if not specified. "serviceLevel": "A String", # Required. Service level of the storage pool "state": "A String", # Output only. State of the storage pool "stateDetails": "A String", # Output only. State details of the storage pool @@ -265,6 +266,7 @@

Method Details

"replicaZone": "A String", # Optional. Specifies the replica zone for regional storagePool. "satisfiesPzi": True or False, # Output only. Reserved for future use "satisfiesPzs": True or False, # Output only. Reserved for future use + "scaleType": "A String", # Optional. The scale type of the storage pool. Defaults to `SCALE_TYPE_DEFAULT` if not specified. "serviceLevel": "A String", # Required. Service level of the storage pool "state": "A String", # Output only. State of the storage pool "stateDetails": "A String", # Output only. State details of the storage pool @@ -325,6 +327,7 @@

Method Details

"replicaZone": "A String", # Optional. Specifies the replica zone for regional storagePool. "satisfiesPzi": True or False, # Output only. Reserved for future use "satisfiesPzs": True or False, # Output only. Reserved for future use + "scaleType": "A String", # Optional. The scale type of the storage pool. Defaults to `SCALE_TYPE_DEFAULT` if not specified. "serviceLevel": "A String", # Required. Service level of the storage pool "state": "A String", # Output only. State of the storage pool "stateDetails": "A String", # Output only. State details of the storage pool @@ -392,6 +395,7 @@

Method Details

"replicaZone": "A String", # Optional. Specifies the replica zone for regional storagePool. "satisfiesPzi": True or False, # Output only. Reserved for future use "satisfiesPzs": True or False, # Output only. Reserved for future use + "scaleType": "A String", # Optional. The scale type of the storage pool. Defaults to `SCALE_TYPE_DEFAULT` if not specified. "serviceLevel": "A String", # Required. Service level of the storage pool "state": "A String", # Output only. State of the storage pool "stateDetails": "A String", # Output only. State details of the storage pool diff --git a/docs/dyn/netapp_v1.projects.locations.volumes.html b/docs/dyn/netapp_v1.projects.locations.volumes.html index 5c3c7019ac..e0c10cd744 100644 --- a/docs/dyn/netapp_v1.projects.locations.volumes.html +++ b/docs/dyn/netapp_v1.projects.locations.volumes.html @@ -236,7 +236,10 @@

Method Details

"labels": { # Optional. Labels as key value pairs "a_key": "A String", }, - "largeCapacity": True or False, # Optional. Flag indicating if the volume will be a large capacity volume or a regular volume. + "largeCapacity": True or False, # Optional. Flag indicating if the volume will be a large capacity volume or a regular volume. This field is used for legacy FILE pools. For Unified pools, use the `large_capacity_config` field instead. This field and `large_capacity_config` are mutually exclusive. + "largeCapacityConfig": { # Configuration for a Large Capacity Volume. A Large Capacity Volume supports sizes ranging from 4.8 TiB to 20 PiB, it is composed of multiple internal constituents, and must be created in a large capacity pool. # Optional. Large capacity config for the volume. Enables and configures large capacity for volumes in Unified pools with File protocols. Not applicable for Block protocols in Unified pools. This field and the legacy `large_capacity` boolean field are mutually exclusive. + "constituentCount": 42, # Optional. The number of internal constituents (e.g., FlexVols) for this large volume. The minimum number of constituents is 2. + }, "ldapEnabled": True or False, # Output only. Flag indicating if the volume is NFS LDAP enabled or not. "mountOptions": [ # Output only. Mount options of this volume { # View only mount options for a volume. @@ -537,7 +540,10 @@

Method Details

"labels": { # Optional. Labels as key value pairs "a_key": "A String", }, - "largeCapacity": True or False, # Optional. Flag indicating if the volume will be a large capacity volume or a regular volume. + "largeCapacity": True or False, # Optional. Flag indicating if the volume will be a large capacity volume or a regular volume. This field is used for legacy FILE pools. For Unified pools, use the `large_capacity_config` field instead. This field and `large_capacity_config` are mutually exclusive. + "largeCapacityConfig": { # Configuration for a Large Capacity Volume. A Large Capacity Volume supports sizes ranging from 4.8 TiB to 20 PiB, it is composed of multiple internal constituents, and must be created in a large capacity pool. # Optional. Large capacity config for the volume. Enables and configures large capacity for volumes in Unified pools with File protocols. Not applicable for Block protocols in Unified pools. This field and the legacy `large_capacity` boolean field are mutually exclusive. + "constituentCount": 42, # Optional. The number of internal constituents (e.g., FlexVols) for this large volume. The minimum number of constituents is 2. + }, "ldapEnabled": True or False, # Output only. Flag indicating if the volume is NFS LDAP enabled or not. "mountOptions": [ # Output only. Mount options of this volume { # View only mount options for a volume. @@ -736,7 +742,10 @@

Method Details

"labels": { # Optional. Labels as key value pairs "a_key": "A String", }, - "largeCapacity": True or False, # Optional. Flag indicating if the volume will be a large capacity volume or a regular volume. + "largeCapacity": True or False, # Optional. Flag indicating if the volume will be a large capacity volume or a regular volume. This field is used for legacy FILE pools. For Unified pools, use the `large_capacity_config` field instead. This field and `large_capacity_config` are mutually exclusive. + "largeCapacityConfig": { # Configuration for a Large Capacity Volume. A Large Capacity Volume supports sizes ranging from 4.8 TiB to 20 PiB, it is composed of multiple internal constituents, and must be created in a large capacity pool. # Optional. Large capacity config for the volume. Enables and configures large capacity for volumes in Unified pools with File protocols. Not applicable for Block protocols in Unified pools. This field and the legacy `large_capacity` boolean field are mutually exclusive. + "constituentCount": 42, # Optional. The number of internal constituents (e.g., FlexVols) for this large volume. The minimum number of constituents is 2. + }, "ldapEnabled": True or False, # Output only. Flag indicating if the volume is NFS LDAP enabled or not. "mountOptions": [ # Output only. Mount options of this volume { # View only mount options for a volume. @@ -936,7 +945,10 @@

Method Details

"labels": { # Optional. Labels as key value pairs "a_key": "A String", }, - "largeCapacity": True or False, # Optional. Flag indicating if the volume will be a large capacity volume or a regular volume. + "largeCapacity": True or False, # Optional. Flag indicating if the volume will be a large capacity volume or a regular volume. This field is used for legacy FILE pools. For Unified pools, use the `large_capacity_config` field instead. This field and `large_capacity_config` are mutually exclusive. + "largeCapacityConfig": { # Configuration for a Large Capacity Volume. A Large Capacity Volume supports sizes ranging from 4.8 TiB to 20 PiB, it is composed of multiple internal constituents, and must be created in a large capacity pool. # Optional. Large capacity config for the volume. Enables and configures large capacity for volumes in Unified pools with File protocols. Not applicable for Block protocols in Unified pools. This field and the legacy `large_capacity` boolean field are mutually exclusive. + "constituentCount": 42, # Optional. The number of internal constituents (e.g., FlexVols) for this large volume. The minimum number of constituents is 2. + }, "ldapEnabled": True or False, # Output only. Flag indicating if the volume is NFS LDAP enabled or not. "mountOptions": [ # Output only. Mount options of this volume { # View only mount options for a volume. diff --git a/docs/dyn/netapp_v1beta1.projects.locations.volumes.html b/docs/dyn/netapp_v1beta1.projects.locations.volumes.html index 1072ad25d7..d4ffabf90b 100644 --- a/docs/dyn/netapp_v1beta1.projects.locations.volumes.html +++ b/docs/dyn/netapp_v1beta1.projects.locations.volumes.html @@ -236,8 +236,8 @@

Method Details

"labels": { # Optional. Labels as key value pairs "a_key": "A String", }, - "largeCapacity": True or False, # Optional. Flag indicating if the volume will be a large capacity volume or a regular volume. - "largeCapacityConfig": { # Configuration for a Large Capacity Volume. A Large Capacity Volume supports sizes ranging from 4.8 TiB to 20 PiB, it is composed of multiple internal constituents, and must be created in a large capacity pool. # Optional. Large capacity config for the volume. + "largeCapacity": True or False, # Optional. Flag indicating if the volume will be a large capacity volume or a regular volume. This field is used for legacy FILE pools. For Unified pools, use the `large_capacity_config` field instead. This field and `large_capacity_config` are mutually exclusive. + "largeCapacityConfig": { # Configuration for a Large Capacity Volume. A Large Capacity Volume supports sizes ranging from 4.8 TiB to 20 PiB, it is composed of multiple internal constituents, and must be created in a large capacity pool. # Optional. Large capacity config for the volume. Enables and configures large capacity for volumes in Unified pools with File protocols. Not applicable for Block protocols in Unified pools. This field and the legacy `large_capacity` boolean field are mutually exclusive. "constituentCount": 42, # Optional. The number of internal constituents (e.g., FlexVols) for this large volume. The minimum number of constituents is 2. }, "ldapEnabled": True or False, # Output only. Flag indicating if the volume is NFS LDAP enabled or not. @@ -540,8 +540,8 @@

Method Details

"labels": { # Optional. Labels as key value pairs "a_key": "A String", }, - "largeCapacity": True or False, # Optional. Flag indicating if the volume will be a large capacity volume or a regular volume. - "largeCapacityConfig": { # Configuration for a Large Capacity Volume. A Large Capacity Volume supports sizes ranging from 4.8 TiB to 20 PiB, it is composed of multiple internal constituents, and must be created in a large capacity pool. # Optional. Large capacity config for the volume. + "largeCapacity": True or False, # Optional. Flag indicating if the volume will be a large capacity volume or a regular volume. This field is used for legacy FILE pools. For Unified pools, use the `large_capacity_config` field instead. This field and `large_capacity_config` are mutually exclusive. + "largeCapacityConfig": { # Configuration for a Large Capacity Volume. A Large Capacity Volume supports sizes ranging from 4.8 TiB to 20 PiB, it is composed of multiple internal constituents, and must be created in a large capacity pool. # Optional. Large capacity config for the volume. Enables and configures large capacity for volumes in Unified pools with File protocols. Not applicable for Block protocols in Unified pools. This field and the legacy `large_capacity` boolean field are mutually exclusive. "constituentCount": 42, # Optional. The number of internal constituents (e.g., FlexVols) for this large volume. The minimum number of constituents is 2. }, "ldapEnabled": True or False, # Output only. Flag indicating if the volume is NFS LDAP enabled or not. @@ -742,8 +742,8 @@

Method Details

"labels": { # Optional. Labels as key value pairs "a_key": "A String", }, - "largeCapacity": True or False, # Optional. Flag indicating if the volume will be a large capacity volume or a regular volume. - "largeCapacityConfig": { # Configuration for a Large Capacity Volume. A Large Capacity Volume supports sizes ranging from 4.8 TiB to 20 PiB, it is composed of multiple internal constituents, and must be created in a large capacity pool. # Optional. Large capacity config for the volume. + "largeCapacity": True or False, # Optional. Flag indicating if the volume will be a large capacity volume or a regular volume. This field is used for legacy FILE pools. For Unified pools, use the `large_capacity_config` field instead. This field and `large_capacity_config` are mutually exclusive. + "largeCapacityConfig": { # Configuration for a Large Capacity Volume. A Large Capacity Volume supports sizes ranging from 4.8 TiB to 20 PiB, it is composed of multiple internal constituents, and must be created in a large capacity pool. # Optional. Large capacity config for the volume. Enables and configures large capacity for volumes in Unified pools with File protocols. Not applicable for Block protocols in Unified pools. This field and the legacy `large_capacity` boolean field are mutually exclusive. "constituentCount": 42, # Optional. The number of internal constituents (e.g., FlexVols) for this large volume. The minimum number of constituents is 2. }, "ldapEnabled": True or False, # Output only. Flag indicating if the volume is NFS LDAP enabled or not. @@ -945,8 +945,8 @@

Method Details

"labels": { # Optional. Labels as key value pairs "a_key": "A String", }, - "largeCapacity": True or False, # Optional. Flag indicating if the volume will be a large capacity volume or a regular volume. - "largeCapacityConfig": { # Configuration for a Large Capacity Volume. A Large Capacity Volume supports sizes ranging from 4.8 TiB to 20 PiB, it is composed of multiple internal constituents, and must be created in a large capacity pool. # Optional. Large capacity config for the volume. + "largeCapacity": True or False, # Optional. Flag indicating if the volume will be a large capacity volume or a regular volume. This field is used for legacy FILE pools. For Unified pools, use the `large_capacity_config` field instead. This field and `large_capacity_config` are mutually exclusive. + "largeCapacityConfig": { # Configuration for a Large Capacity Volume. A Large Capacity Volume supports sizes ranging from 4.8 TiB to 20 PiB, it is composed of multiple internal constituents, and must be created in a large capacity pool. # Optional. Large capacity config for the volume. Enables and configures large capacity for volumes in Unified pools with File protocols. Not applicable for Block protocols in Unified pools. This field and the legacy `large_capacity` boolean field are mutually exclusive. "constituentCount": 42, # Optional. The number of internal constituents (e.g., FlexVols) for this large volume. The minimum number of constituents is 2. }, "ldapEnabled": True or False, # Output only. Flag indicating if the volume is NFS LDAP enabled or not. diff --git a/docs/dyn/networkmanagement_v1.organizations.locations.html b/docs/dyn/networkmanagement_v1.organizations.locations.html index 7b053697af..a1f0040e47 100644 --- a/docs/dyn/networkmanagement_v1.organizations.locations.html +++ b/docs/dyn/networkmanagement_v1.organizations.locations.html @@ -92,7 +92,7 @@

Instance Methods

Gets information about a location.

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

-

Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.

+

Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.

list_next()

Retrieves the next page of results.

@@ -131,7 +131,7 @@

Method Details

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
+  
Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
diff --git a/docs/dyn/networkmanagement_v1.projects.locations.html b/docs/dyn/networkmanagement_v1.projects.locations.html
index 556a2af530..d9c73c2af0 100644
--- a/docs/dyn/networkmanagement_v1.projects.locations.html
+++ b/docs/dyn/networkmanagement_v1.projects.locations.html
@@ -92,7 +92,7 @@ 

Instance Methods

Gets information about a location.

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

-

Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.

+

Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.

list_next()

Retrieves the next page of results.

@@ -131,7 +131,7 @@

Method Details

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
+  
Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
diff --git a/docs/dyn/networkmanagement_v1beta1.organizations.locations.html b/docs/dyn/networkmanagement_v1beta1.organizations.locations.html
index 5a3520a24b..80d6442eb2 100644
--- a/docs/dyn/networkmanagement_v1beta1.organizations.locations.html
+++ b/docs/dyn/networkmanagement_v1beta1.organizations.locations.html
@@ -92,7 +92,7 @@ 

Instance Methods

Gets information about a location.

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

-

Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.

+

Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.

list_next()

Retrieves the next page of results.

@@ -131,7 +131,7 @@

Method Details

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
+  
Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
diff --git a/docs/dyn/networkmanagement_v1beta1.projects.locations.html b/docs/dyn/networkmanagement_v1beta1.projects.locations.html
index bce8df1999..02bc3d3b0c 100644
--- a/docs/dyn/networkmanagement_v1beta1.projects.locations.html
+++ b/docs/dyn/networkmanagement_v1beta1.projects.locations.html
@@ -92,7 +92,7 @@ 

Instance Methods

Gets information about a location.

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

-

Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.

+

Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.

list_next()

Retrieves the next page of results.

@@ -131,7 +131,7 @@

Method Details

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
+  
Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
diff --git a/docs/dyn/networksecurity_v1.organizations.locations.firewallEndpoints.html b/docs/dyn/networksecurity_v1.organizations.locations.firewallEndpoints.html
index 79780292f4..04dd716aac 100644
--- a/docs/dyn/networksecurity_v1.organizations.locations.firewallEndpoints.html
+++ b/docs/dyn/networksecurity_v1.organizations.locations.firewallEndpoints.html
@@ -120,7 +120,7 @@ 

Method Details

"network": "A String", # Output only. The VPC network associated. Format: projects/{project}/global/networks/{name}. }, ], - "billingProjectId": "A String", # Required. Project to bill on endpoint uptime usage. + "billingProjectId": "A String", # Optional. Project to charge for the deployed firewall endpoint. This field must be specified when creating the endpoint in the organization scope, and should be omitted otherwise. "createTime": "A String", # Output only. Create time stamp. "description": "A String", # Optional. Description of the firewall endpoint. Max length 2048 characters. "endpointSettings": { # Settings for the endpoint. # Optional. Settings for the endpoint. @@ -228,7 +228,7 @@

Method Details

"network": "A String", # Output only. The VPC network associated. Format: projects/{project}/global/networks/{name}. }, ], - "billingProjectId": "A String", # Required. Project to bill on endpoint uptime usage. + "billingProjectId": "A String", # Optional. Project to charge for the deployed firewall endpoint. This field must be specified when creating the endpoint in the organization scope, and should be omitted otherwise. "createTime": "A String", # Output only. Create time stamp. "description": "A String", # Optional. Description of the firewall endpoint. Max length 2048 characters. "endpointSettings": { # Settings for the endpoint. # Optional. Settings for the endpoint. @@ -276,7 +276,7 @@

Method Details

"network": "A String", # Output only. The VPC network associated. Format: projects/{project}/global/networks/{name}. }, ], - "billingProjectId": "A String", # Required. Project to bill on endpoint uptime usage. + "billingProjectId": "A String", # Optional. Project to charge for the deployed firewall endpoint. This field must be specified when creating the endpoint in the organization scope, and should be omitted otherwise. "createTime": "A String", # Output only. Create time stamp. "description": "A String", # Optional. Description of the firewall endpoint. Max length 2048 characters. "endpointSettings": { # Settings for the endpoint. # Optional. Settings for the endpoint. @@ -333,7 +333,7 @@

Method Details

"network": "A String", # Output only. The VPC network associated. Format: projects/{project}/global/networks/{name}. }, ], - "billingProjectId": "A String", # Required. Project to bill on endpoint uptime usage. + "billingProjectId": "A String", # Optional. Project to charge for the deployed firewall endpoint. This field must be specified when creating the endpoint in the organization scope, and should be omitted otherwise. "createTime": "A String", # Output only. Create time stamp. "description": "A String", # Optional. Description of the firewall endpoint. Max length 2048 characters. "endpointSettings": { # Settings for the endpoint. # Optional. Settings for the endpoint. diff --git a/docs/dyn/networksecurity_v1.projects.locations.authzPolicies.html b/docs/dyn/networksecurity_v1.projects.locations.authzPolicies.html index 3e0b1f0c9e..e8eb73d354 100644 --- a/docs/dyn/networksecurity_v1.projects.locations.authzPolicies.html +++ b/docs/dyn/networksecurity_v1.projects.locations.authzPolicies.html @@ -238,6 +238,23 @@

Method Details

"suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` }, ], + "mcp": { # Describes a set of MCP protocol attributes to match against for a given MCP request. # Optional. Defines the MCP protocol attributes to match on. If the MCP payload in the request body cannot be successfully parsed, the request will be denied. This field can be set only for AuthzPolicies targeting AgentGateway resources. + "baseProtocolMethodsOption": "A String", # Optional. If specified, matches on the MCP protocol’s non-access specific methods namely: * initialize * completion/ * logging/ * notifications/ * ping Defaults to SKIP_BASE_PROTOCOL_METHODS if not specified. + "methods": [ # Optional. A list of MCP methods and associated parameters to match on. It is recommended to use this field to match on tools, prompts and resource accesses while setting the baseProtocolMethodsOption to MATCH_BASE_PROTOCOL_METHODS to match on all the other MCP protocol methods. Limited to 10 MCP methods per Authorization Policy. + { # Describes a set of MCP methods to match against. + "name": "A String", # Required. The MCP method to match against. Allowed values are as follows: 1. `tools`, `prompts`, `resources` - these will match against all sub methods under the respective methods. 2. `prompts/list`, `tools/list`, `resources/list`, `resources/templates/list` 3. `prompts/get`, `tools/call`, `resources/subscribe`, `resources/unsubscribe`, `resources/read` Params cannot be specified for categories 1 and 2. + "params": [ # Optional. A list of MCP method parameters to match against. The match can be one of exact, prefix, suffix, or contains (substring match). Matches are always case sensitive unless the ignoreCase is set. Limited to 10 MCP method parameters per Authorization Policy. + { # Determines how a string value should be matched. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + ], + }, + ], + }, "methods": [ # Optional. A list of HTTP methods to match against. Each entry must be a valid HTTP method name (GET, PUT, POST, HEAD, PATCH, DELETE, OPTIONS). It only allows exact match and is always case sensitive. Limited to 10 methods per Authorization Policy. "A String", ], @@ -277,6 +294,23 @@

Method Details

"suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` }, ], + "mcp": { # Describes a set of MCP protocol attributes to match against for a given MCP request. # Optional. Defines the MCP protocol attributes to match on. If the MCP payload in the request body cannot be successfully parsed, the request will be denied. This field can be set only for AuthzPolicies targeting AgentGateway resources. + "baseProtocolMethodsOption": "A String", # Optional. If specified, matches on the MCP protocol’s non-access specific methods namely: * initialize * completion/ * logging/ * notifications/ * ping Defaults to SKIP_BASE_PROTOCOL_METHODS if not specified. + "methods": [ # Optional. A list of MCP methods and associated parameters to match on. It is recommended to use this field to match on tools, prompts and resource accesses while setting the baseProtocolMethodsOption to MATCH_BASE_PROTOCOL_METHODS to match on all the other MCP protocol methods. Limited to 10 MCP methods per Authorization Policy. + { # Describes a set of MCP methods to match against. + "name": "A String", # Required. The MCP method to match against. Allowed values are as follows: 1. `tools`, `prompts`, `resources` - these will match against all sub methods under the respective methods. 2. `prompts/list`, `tools/list`, `resources/list`, `resources/templates/list` 3. `prompts/get`, `tools/call`, `resources/subscribe`, `resources/unsubscribe`, `resources/read` Params cannot be specified for categories 1 and 2. + "params": [ # Optional. A list of MCP method parameters to match against. The match can be one of exact, prefix, suffix, or contains (substring match). Matches are always case sensitive unless the ignoreCase is set. Limited to 10 MCP method parameters per Authorization Policy. + { # Determines how a string value should be matched. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + ], + }, + ], + }, "methods": [ # Optional. A list of HTTP methods to match against. Each entry must be a valid HTTP method name (GET, PUT, POST, HEAD, PATCH, DELETE, OPTIONS). It only allows exact match and is always case sensitive. Limited to 10 methods per Authorization Policy. "A String", ], @@ -299,8 +333,9 @@

Method Details

"a_key": "A String", }, "name": "A String", # Required. Identifier. Name of the `AuthzPolicy` resource in the following format: `projects/{project}/locations/{location}/authzPolicies/{authz_policy}`. + "policyProfile": "A String", # Optional. Immutable. Defines the type of authorization being performed. If not specified, `REQUEST_AUTHZ` is applied. This field cannot be changed once AuthzPolicy is created. "target": { # Specifies the set of targets to which this policy should be applied to. # Required. Specifies the set of resources to which this policy should be applied to. - "loadBalancingScheme": "A String", # Required. All gateways and forwarding rules referenced by this policy and extensions must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED` and `EXTERNAL_MANAGED`. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service). + "loadBalancingScheme": "A String", # Optional. All gateways and forwarding rules referenced by this policy and extensions must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED` and `EXTERNAL_MANAGED`. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service). "resources": [ # Required. A list of references to the Forwarding Rules on which this policy will be applied. "A String", ], @@ -508,6 +543,23 @@

Method Details

"suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` }, ], + "mcp": { # Describes a set of MCP protocol attributes to match against for a given MCP request. # Optional. Defines the MCP protocol attributes to match on. If the MCP payload in the request body cannot be successfully parsed, the request will be denied. This field can be set only for AuthzPolicies targeting AgentGateway resources. + "baseProtocolMethodsOption": "A String", # Optional. If specified, matches on the MCP protocol’s non-access specific methods namely: * initialize * completion/ * logging/ * notifications/ * ping Defaults to SKIP_BASE_PROTOCOL_METHODS if not specified. + "methods": [ # Optional. A list of MCP methods and associated parameters to match on. It is recommended to use this field to match on tools, prompts and resource accesses while setting the baseProtocolMethodsOption to MATCH_BASE_PROTOCOL_METHODS to match on all the other MCP protocol methods. Limited to 10 MCP methods per Authorization Policy. + { # Describes a set of MCP methods to match against. + "name": "A String", # Required. The MCP method to match against. Allowed values are as follows: 1. `tools`, `prompts`, `resources` - these will match against all sub methods under the respective methods. 2. `prompts/list`, `tools/list`, `resources/list`, `resources/templates/list` 3. `prompts/get`, `tools/call`, `resources/subscribe`, `resources/unsubscribe`, `resources/read` Params cannot be specified for categories 1 and 2. + "params": [ # Optional. A list of MCP method parameters to match against. The match can be one of exact, prefix, suffix, or contains (substring match). Matches are always case sensitive unless the ignoreCase is set. Limited to 10 MCP method parameters per Authorization Policy. + { # Determines how a string value should be matched. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + ], + }, + ], + }, "methods": [ # Optional. A list of HTTP methods to match against. Each entry must be a valid HTTP method name (GET, PUT, POST, HEAD, PATCH, DELETE, OPTIONS). It only allows exact match and is always case sensitive. Limited to 10 methods per Authorization Policy. "A String", ], @@ -547,6 +599,23 @@

Method Details

"suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` }, ], + "mcp": { # Describes a set of MCP protocol attributes to match against for a given MCP request. # Optional. Defines the MCP protocol attributes to match on. If the MCP payload in the request body cannot be successfully parsed, the request will be denied. This field can be set only for AuthzPolicies targeting AgentGateway resources. + "baseProtocolMethodsOption": "A String", # Optional. If specified, matches on the MCP protocol’s non-access specific methods namely: * initialize * completion/ * logging/ * notifications/ * ping Defaults to SKIP_BASE_PROTOCOL_METHODS if not specified. + "methods": [ # Optional. A list of MCP methods and associated parameters to match on. It is recommended to use this field to match on tools, prompts and resource accesses while setting the baseProtocolMethodsOption to MATCH_BASE_PROTOCOL_METHODS to match on all the other MCP protocol methods. Limited to 10 MCP methods per Authorization Policy. + { # Describes a set of MCP methods to match against. + "name": "A String", # Required. The MCP method to match against. Allowed values are as follows: 1. `tools`, `prompts`, `resources` - these will match against all sub methods under the respective methods. 2. `prompts/list`, `tools/list`, `resources/list`, `resources/templates/list` 3. `prompts/get`, `tools/call`, `resources/subscribe`, `resources/unsubscribe`, `resources/read` Params cannot be specified for categories 1 and 2. + "params": [ # Optional. A list of MCP method parameters to match against. The match can be one of exact, prefix, suffix, or contains (substring match). Matches are always case sensitive unless the ignoreCase is set. Limited to 10 MCP method parameters per Authorization Policy. + { # Determines how a string value should be matched. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + ], + }, + ], + }, "methods": [ # Optional. A list of HTTP methods to match against. Each entry must be a valid HTTP method name (GET, PUT, POST, HEAD, PATCH, DELETE, OPTIONS). It only allows exact match and is always case sensitive. Limited to 10 methods per Authorization Policy. "A String", ], @@ -569,8 +638,9 @@

Method Details

"a_key": "A String", }, "name": "A String", # Required. Identifier. Name of the `AuthzPolicy` resource in the following format: `projects/{project}/locations/{location}/authzPolicies/{authz_policy}`. + "policyProfile": "A String", # Optional. Immutable. Defines the type of authorization being performed. If not specified, `REQUEST_AUTHZ` is applied. This field cannot be changed once AuthzPolicy is created. "target": { # Specifies the set of targets to which this policy should be applied to. # Required. Specifies the set of resources to which this policy should be applied to. - "loadBalancingScheme": "A String", # Required. All gateways and forwarding rules referenced by this policy and extensions must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED` and `EXTERNAL_MANAGED`. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service). + "loadBalancingScheme": "A String", # Optional. All gateways and forwarding rules referenced by this policy and extensions must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED` and `EXTERNAL_MANAGED`. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service). "resources": [ # Required. A list of references to the Forwarding Rules on which this policy will be applied. "A String", ], @@ -766,6 +836,23 @@

Method Details

"suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` }, ], + "mcp": { # Describes a set of MCP protocol attributes to match against for a given MCP request. # Optional. Defines the MCP protocol attributes to match on. If the MCP payload in the request body cannot be successfully parsed, the request will be denied. This field can be set only for AuthzPolicies targeting AgentGateway resources. + "baseProtocolMethodsOption": "A String", # Optional. If specified, matches on the MCP protocol’s non-access specific methods namely: * initialize * completion/ * logging/ * notifications/ * ping Defaults to SKIP_BASE_PROTOCOL_METHODS if not specified. + "methods": [ # Optional. A list of MCP methods and associated parameters to match on. It is recommended to use this field to match on tools, prompts and resource accesses while setting the baseProtocolMethodsOption to MATCH_BASE_PROTOCOL_METHODS to match on all the other MCP protocol methods. Limited to 10 MCP methods per Authorization Policy. + { # Describes a set of MCP methods to match against. + "name": "A String", # Required. The MCP method to match against. Allowed values are as follows: 1. `tools`, `prompts`, `resources` - these will match against all sub methods under the respective methods. 2. `prompts/list`, `tools/list`, `resources/list`, `resources/templates/list` 3. `prompts/get`, `tools/call`, `resources/subscribe`, `resources/unsubscribe`, `resources/read` Params cannot be specified for categories 1 and 2. + "params": [ # Optional. A list of MCP method parameters to match against. The match can be one of exact, prefix, suffix, or contains (substring match). Matches are always case sensitive unless the ignoreCase is set. Limited to 10 MCP method parameters per Authorization Policy. + { # Determines how a string value should be matched. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + ], + }, + ], + }, "methods": [ # Optional. A list of HTTP methods to match against. Each entry must be a valid HTTP method name (GET, PUT, POST, HEAD, PATCH, DELETE, OPTIONS). It only allows exact match and is always case sensitive. Limited to 10 methods per Authorization Policy. "A String", ], @@ -805,6 +892,23 @@

Method Details

"suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` }, ], + "mcp": { # Describes a set of MCP protocol attributes to match against for a given MCP request. # Optional. Defines the MCP protocol attributes to match on. If the MCP payload in the request body cannot be successfully parsed, the request will be denied. This field can be set only for AuthzPolicies targeting AgentGateway resources. + "baseProtocolMethodsOption": "A String", # Optional. If specified, matches on the MCP protocol’s non-access specific methods namely: * initialize * completion/ * logging/ * notifications/ * ping Defaults to SKIP_BASE_PROTOCOL_METHODS if not specified. + "methods": [ # Optional. A list of MCP methods and associated parameters to match on. It is recommended to use this field to match on tools, prompts and resource accesses while setting the baseProtocolMethodsOption to MATCH_BASE_PROTOCOL_METHODS to match on all the other MCP protocol methods. Limited to 10 MCP methods per Authorization Policy. + { # Describes a set of MCP methods to match against. + "name": "A String", # Required. The MCP method to match against. Allowed values are as follows: 1. `tools`, `prompts`, `resources` - these will match against all sub methods under the respective methods. 2. `prompts/list`, `tools/list`, `resources/list`, `resources/templates/list` 3. `prompts/get`, `tools/call`, `resources/subscribe`, `resources/unsubscribe`, `resources/read` Params cannot be specified for categories 1 and 2. + "params": [ # Optional. A list of MCP method parameters to match against. The match can be one of exact, prefix, suffix, or contains (substring match). Matches are always case sensitive unless the ignoreCase is set. Limited to 10 MCP method parameters per Authorization Policy. + { # Determines how a string value should be matched. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + ], + }, + ], + }, "methods": [ # Optional. A list of HTTP methods to match against. Each entry must be a valid HTTP method name (GET, PUT, POST, HEAD, PATCH, DELETE, OPTIONS). It only allows exact match and is always case sensitive. Limited to 10 methods per Authorization Policy. "A String", ], @@ -827,8 +931,9 @@

Method Details

"a_key": "A String", }, "name": "A String", # Required. Identifier. Name of the `AuthzPolicy` resource in the following format: `projects/{project}/locations/{location}/authzPolicies/{authz_policy}`. + "policyProfile": "A String", # Optional. Immutable. Defines the type of authorization being performed. If not specified, `REQUEST_AUTHZ` is applied. This field cannot be changed once AuthzPolicy is created. "target": { # Specifies the set of targets to which this policy should be applied to. # Required. Specifies the set of resources to which this policy should be applied to. - "loadBalancingScheme": "A String", # Required. All gateways and forwarding rules referenced by this policy and extensions must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED` and `EXTERNAL_MANAGED`. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service). + "loadBalancingScheme": "A String", # Optional. All gateways and forwarding rules referenced by this policy and extensions must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED` and `EXTERNAL_MANAGED`. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service). "resources": [ # Required. A list of references to the Forwarding Rules on which this policy will be applied. "A String", ], @@ -985,6 +1090,23 @@

Method Details

"suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` }, ], + "mcp": { # Describes a set of MCP protocol attributes to match against for a given MCP request. # Optional. Defines the MCP protocol attributes to match on. If the MCP payload in the request body cannot be successfully parsed, the request will be denied. This field can be set only for AuthzPolicies targeting AgentGateway resources. + "baseProtocolMethodsOption": "A String", # Optional. If specified, matches on the MCP protocol’s non-access specific methods namely: * initialize * completion/ * logging/ * notifications/ * ping Defaults to SKIP_BASE_PROTOCOL_METHODS if not specified. + "methods": [ # Optional. A list of MCP methods and associated parameters to match on. It is recommended to use this field to match on tools, prompts and resource accesses while setting the baseProtocolMethodsOption to MATCH_BASE_PROTOCOL_METHODS to match on all the other MCP protocol methods. Limited to 10 MCP methods per Authorization Policy. + { # Describes a set of MCP methods to match against. + "name": "A String", # Required. The MCP method to match against. Allowed values are as follows: 1. `tools`, `prompts`, `resources` - these will match against all sub methods under the respective methods. 2. `prompts/list`, `tools/list`, `resources/list`, `resources/templates/list` 3. `prompts/get`, `tools/call`, `resources/subscribe`, `resources/unsubscribe`, `resources/read` Params cannot be specified for categories 1 and 2. + "params": [ # Optional. A list of MCP method parameters to match against. The match can be one of exact, prefix, suffix, or contains (substring match). Matches are always case sensitive unless the ignoreCase is set. Limited to 10 MCP method parameters per Authorization Policy. + { # Determines how a string value should be matched. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + ], + }, + ], + }, "methods": [ # Optional. A list of HTTP methods to match against. Each entry must be a valid HTTP method name (GET, PUT, POST, HEAD, PATCH, DELETE, OPTIONS). It only allows exact match and is always case sensitive. Limited to 10 methods per Authorization Policy. "A String", ], @@ -1024,6 +1146,23 @@

Method Details

"suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` }, ], + "mcp": { # Describes a set of MCP protocol attributes to match against for a given MCP request. # Optional. Defines the MCP protocol attributes to match on. If the MCP payload in the request body cannot be successfully parsed, the request will be denied. This field can be set only for AuthzPolicies targeting AgentGateway resources. + "baseProtocolMethodsOption": "A String", # Optional. If specified, matches on the MCP protocol’s non-access specific methods namely: * initialize * completion/ * logging/ * notifications/ * ping Defaults to SKIP_BASE_PROTOCOL_METHODS if not specified. + "methods": [ # Optional. A list of MCP methods and associated parameters to match on. It is recommended to use this field to match on tools, prompts and resource accesses while setting the baseProtocolMethodsOption to MATCH_BASE_PROTOCOL_METHODS to match on all the other MCP protocol methods. Limited to 10 MCP methods per Authorization Policy. + { # Describes a set of MCP methods to match against. + "name": "A String", # Required. The MCP method to match against. Allowed values are as follows: 1. `tools`, `prompts`, `resources` - these will match against all sub methods under the respective methods. 2. `prompts/list`, `tools/list`, `resources/list`, `resources/templates/list` 3. `prompts/get`, `tools/call`, `resources/subscribe`, `resources/unsubscribe`, `resources/read` Params cannot be specified for categories 1 and 2. + "params": [ # Optional. A list of MCP method parameters to match against. The match can be one of exact, prefix, suffix, or contains (substring match). Matches are always case sensitive unless the ignoreCase is set. Limited to 10 MCP method parameters per Authorization Policy. + { # Determines how a string value should be matched. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + ], + }, + ], + }, "methods": [ # Optional. A list of HTTP methods to match against. Each entry must be a valid HTTP method name (GET, PUT, POST, HEAD, PATCH, DELETE, OPTIONS). It only allows exact match and is always case sensitive. Limited to 10 methods per Authorization Policy. "A String", ], @@ -1046,8 +1185,9 @@

Method Details

"a_key": "A String", }, "name": "A String", # Required. Identifier. Name of the `AuthzPolicy` resource in the following format: `projects/{project}/locations/{location}/authzPolicies/{authz_policy}`. + "policyProfile": "A String", # Optional. Immutable. Defines the type of authorization being performed. If not specified, `REQUEST_AUTHZ` is applied. This field cannot be changed once AuthzPolicy is created. "target": { # Specifies the set of targets to which this policy should be applied to. # Required. Specifies the set of resources to which this policy should be applied to. - "loadBalancingScheme": "A String", # Required. All gateways and forwarding rules referenced by this policy and extensions must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED` and `EXTERNAL_MANAGED`. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service). + "loadBalancingScheme": "A String", # Optional. All gateways and forwarding rules referenced by this policy and extensions must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED` and `EXTERNAL_MANAGED`. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service). "resources": [ # Required. A list of references to the Forwarding Rules on which this policy will be applied. "A String", ], diff --git a/docs/dyn/networksecurity_v1.projects.locations.html b/docs/dyn/networksecurity_v1.projects.locations.html index 6f3b2afa7b..89750cfa2d 100644 --- a/docs/dyn/networksecurity_v1.projects.locations.html +++ b/docs/dyn/networksecurity_v1.projects.locations.html @@ -182,7 +182,7 @@

Instance Methods

Gets information about a location.

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

-

Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.

+

Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.

list_next()

Retrieves the next page of results.

@@ -221,7 +221,7 @@

Method Details

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
+  
Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
diff --git a/docs/dyn/networksecurity_v1.projects.locations.interceptEndpointGroupAssociations.html b/docs/dyn/networksecurity_v1.projects.locations.interceptEndpointGroupAssociations.html
index e9e0d91807..eebe4939e4 100644
--- a/docs/dyn/networksecurity_v1.projects.locations.interceptEndpointGroupAssociations.html
+++ b/docs/dyn/networksecurity_v1.projects.locations.interceptEndpointGroupAssociations.html
@@ -130,6 +130,7 @@ 

Method Details

], "name": "A String", # Immutable. Identifier. The resource name of this endpoint group association, for example: `projects/123456789/locations/global/interceptEndpointGroupAssociations/my-eg-association`. See https://google.aip.dev/122 for more details. "network": "A String", # Required. Immutable. The VPC network that is associated. for example: `projects/123456789/global/networks/my-network`. See https://google.aip.dev/124. + "networkCookie": 42, # Output only. Identifier used by the data-path. See the NSI GENEVE format for more details: https://docs.cloud.google.com/network-security-integration/docs/understand-geneve#network_id "reconciling": True or False, # Output only. The current state of the resource does not match the user's intended state, and the system is working to reconcile them. This part of the normal operation (e.g. adding a new location to the target deployment group). See https://google.aip.dev/128. "state": "A String", # Output only. Current state of the endpoint group association. "updateTime": "A String", # Output only. The timestamp when the resource was most recently updated. See https://google.aip.dev/148#timestamps. @@ -236,6 +237,7 @@

Method Details

], "name": "A String", # Immutable. Identifier. The resource name of this endpoint group association, for example: `projects/123456789/locations/global/interceptEndpointGroupAssociations/my-eg-association`. See https://google.aip.dev/122 for more details. "network": "A String", # Required. Immutable. The VPC network that is associated. for example: `projects/123456789/global/networks/my-network`. See https://google.aip.dev/124. + "networkCookie": 42, # Output only. Identifier used by the data-path. See the NSI GENEVE format for more details: https://docs.cloud.google.com/network-security-integration/docs/understand-geneve#network_id "reconciling": True or False, # Output only. The current state of the resource does not match the user's intended state, and the system is working to reconcile them. This part of the normal operation (e.g. adding a new location to the target deployment group). See https://google.aip.dev/128. "state": "A String", # Output only. Current state of the endpoint group association. "updateTime": "A String", # Output only. The timestamp when the resource was most recently updated. See https://google.aip.dev/148#timestamps. @@ -282,6 +284,7 @@

Method Details

], "name": "A String", # Immutable. Identifier. The resource name of this endpoint group association, for example: `projects/123456789/locations/global/interceptEndpointGroupAssociations/my-eg-association`. See https://google.aip.dev/122 for more details. "network": "A String", # Required. Immutable. The VPC network that is associated. for example: `projects/123456789/global/networks/my-network`. See https://google.aip.dev/124. + "networkCookie": 42, # Output only. Identifier used by the data-path. See the NSI GENEVE format for more details: https://docs.cloud.google.com/network-security-integration/docs/understand-geneve#network_id "reconciling": True or False, # Output only. The current state of the resource does not match the user's intended state, and the system is working to reconcile them. This part of the normal operation (e.g. adding a new location to the target deployment group). See https://google.aip.dev/128. "state": "A String", # Output only. Current state of the endpoint group association. "updateTime": "A String", # Output only. The timestamp when the resource was most recently updated. See https://google.aip.dev/148#timestamps. @@ -334,6 +337,7 @@

Method Details

], "name": "A String", # Immutable. Identifier. The resource name of this endpoint group association, for example: `projects/123456789/locations/global/interceptEndpointGroupAssociations/my-eg-association`. See https://google.aip.dev/122 for more details. "network": "A String", # Required. Immutable. The VPC network that is associated. for example: `projects/123456789/global/networks/my-network`. See https://google.aip.dev/124. + "networkCookie": 42, # Output only. Identifier used by the data-path. See the NSI GENEVE format for more details: https://docs.cloud.google.com/network-security-integration/docs/understand-geneve#network_id "reconciling": True or False, # Output only. The current state of the resource does not match the user's intended state, and the system is working to reconcile them. This part of the normal operation (e.g. adding a new location to the target deployment group). See https://google.aip.dev/128. "state": "A String", # Output only. Current state of the endpoint group association. "updateTime": "A String", # Output only. The timestamp when the resource was most recently updated. See https://google.aip.dev/148#timestamps. diff --git a/docs/dyn/networkservices_v1.projects.locations.gateways.html b/docs/dyn/networkservices_v1.projects.locations.gateways.html index b5e3ca3cc8..cc9876432a 100644 --- a/docs/dyn/networkservices_v1.projects.locations.gateways.html +++ b/docs/dyn/networkservices_v1.projects.locations.gateways.html @@ -119,6 +119,7 @@

Method Details

"addresses": [ # Optional. Zero or one IPv4 or IPv6 address on which the Gateway will receive the traffic. When no address is provided, an IP from the subnetwork is allocated This field only applies to gateways of type 'SECURE_WEB_GATEWAY'. Gateways of type 'OPEN_MESH' listen on 0.0.0.0 for IPv4 and :: for IPv6. "A String", ], + "allPorts": True or False, # Optional. If true, the Gateway will listen on all ports. This is mutually exclusive with the `ports` field. This field only applies to gateways of type 'SECURE_WEB_GATEWAY'. "allowGlobalAccess": True or False, # Optional. If true, the gateway will allow traffic from clients outside of the region where the gateway is located. This field is configurable only for gateways of type SECURE_WEB_GATEWAY. "certificateUrls": [ # Optional. A fully-qualified Certificates URL reference. The proxy presents a Certificate (selected based on SNI) when establishing a TLS connection. This feature only applies to gateways of type 'SECURE_WEB_GATEWAY'. "A String", @@ -228,6 +229,7 @@

Method Details

"addresses": [ # Optional. Zero or one IPv4 or IPv6 address on which the Gateway will receive the traffic. When no address is provided, an IP from the subnetwork is allocated This field only applies to gateways of type 'SECURE_WEB_GATEWAY'. Gateways of type 'OPEN_MESH' listen on 0.0.0.0 for IPv4 and :: for IPv6. "A String", ], + "allPorts": True or False, # Optional. If true, the Gateway will listen on all ports. This is mutually exclusive with the `ports` field. This field only applies to gateways of type 'SECURE_WEB_GATEWAY'. "allowGlobalAccess": True or False, # Optional. If true, the gateway will allow traffic from clients outside of the region where the gateway is located. This field is configurable only for gateways of type SECURE_WEB_GATEWAY. "certificateUrls": [ # Optional. A fully-qualified Certificates URL reference. The proxy presents a Certificate (selected based on SNI) when establishing a TLS connection. This feature only applies to gateways of type 'SECURE_WEB_GATEWAY'. "A String", @@ -277,6 +279,7 @@

Method Details

"addresses": [ # Optional. Zero or one IPv4 or IPv6 address on which the Gateway will receive the traffic. When no address is provided, an IP from the subnetwork is allocated This field only applies to gateways of type 'SECURE_WEB_GATEWAY'. Gateways of type 'OPEN_MESH' listen on 0.0.0.0 for IPv4 and :: for IPv6. "A String", ], + "allPorts": True or False, # Optional. If true, the Gateway will listen on all ports. This is mutually exclusive with the `ports` field. This field only applies to gateways of type 'SECURE_WEB_GATEWAY'. "allowGlobalAccess": True or False, # Optional. If true, the gateway will allow traffic from clients outside of the region where the gateway is located. This field is configurable only for gateways of type SECURE_WEB_GATEWAY. "certificateUrls": [ # Optional. A fully-qualified Certificates URL reference. The proxy presents a Certificate (selected based on SNI) when establishing a TLS connection. This feature only applies to gateways of type 'SECURE_WEB_GATEWAY'. "A String", @@ -337,6 +340,7 @@

Method Details

"addresses": [ # Optional. Zero or one IPv4 or IPv6 address on which the Gateway will receive the traffic. When no address is provided, an IP from the subnetwork is allocated This field only applies to gateways of type 'SECURE_WEB_GATEWAY'. Gateways of type 'OPEN_MESH' listen on 0.0.0.0 for IPv4 and :: for IPv6. "A String", ], + "allPorts": True or False, # Optional. If true, the Gateway will listen on all ports. This is mutually exclusive with the `ports` field. This field only applies to gateways of type 'SECURE_WEB_GATEWAY'. "allowGlobalAccess": True or False, # Optional. If true, the gateway will allow traffic from clients outside of the region where the gateway is located. This field is configurable only for gateways of type SECURE_WEB_GATEWAY. "certificateUrls": [ # Optional. A fully-qualified Certificates URL reference. The proxy presents a Certificate (selected based on SNI) when establishing a TLS connection. This feature only applies to gateways of type 'SECURE_WEB_GATEWAY'. "A String", diff --git a/docs/dyn/networkservices_v1beta1.projects.locations.gateways.html b/docs/dyn/networkservices_v1beta1.projects.locations.gateways.html index fb80e0acad..b39163614c 100644 --- a/docs/dyn/networkservices_v1beta1.projects.locations.gateways.html +++ b/docs/dyn/networkservices_v1beta1.projects.locations.gateways.html @@ -119,6 +119,7 @@

Method Details

"addresses": [ # Optional. Zero or one IPv4 or IPv6 address on which the Gateway will receive the traffic. When no address is provided, an IP from the subnetwork is allocated This field only applies to gateways of type 'SECURE_WEB_GATEWAY'. Gateways of type 'OPEN_MESH' listen on 0.0.0.0 for IPv4 and :: for IPv6. "A String", ], + "allPorts": True or False, # Optional. If true, the Gateway will listen on all ports. This is mutually exclusive with the `ports` field. This field only applies to gateways of type 'SECURE_WEB_GATEWAY'. "allowGlobalAccess": True or False, # Optional. If true, the gateway will allow traffic from clients outside of the region where the gateway is located. This field is configurable only for gateways of type SECURE_WEB_GATEWAY. "certificateUrls": [ # Optional. A fully-qualified Certificates URL reference. The proxy presents a Certificate (selected based on SNI) when establishing a TLS connection. This feature only applies to gateways of type 'SECURE_WEB_GATEWAY'. "A String", @@ -228,6 +229,7 @@

Method Details

"addresses": [ # Optional. Zero or one IPv4 or IPv6 address on which the Gateway will receive the traffic. When no address is provided, an IP from the subnetwork is allocated This field only applies to gateways of type 'SECURE_WEB_GATEWAY'. Gateways of type 'OPEN_MESH' listen on 0.0.0.0 for IPv4 and :: for IPv6. "A String", ], + "allPorts": True or False, # Optional. If true, the Gateway will listen on all ports. This is mutually exclusive with the `ports` field. This field only applies to gateways of type 'SECURE_WEB_GATEWAY'. "allowGlobalAccess": True or False, # Optional. If true, the gateway will allow traffic from clients outside of the region where the gateway is located. This field is configurable only for gateways of type SECURE_WEB_GATEWAY. "certificateUrls": [ # Optional. A fully-qualified Certificates URL reference. The proxy presents a Certificate (selected based on SNI) when establishing a TLS connection. This feature only applies to gateways of type 'SECURE_WEB_GATEWAY'. "A String", @@ -277,6 +279,7 @@

Method Details

"addresses": [ # Optional. Zero or one IPv4 or IPv6 address on which the Gateway will receive the traffic. When no address is provided, an IP from the subnetwork is allocated This field only applies to gateways of type 'SECURE_WEB_GATEWAY'. Gateways of type 'OPEN_MESH' listen on 0.0.0.0 for IPv4 and :: for IPv6. "A String", ], + "allPorts": True or False, # Optional. If true, the Gateway will listen on all ports. This is mutually exclusive with the `ports` field. This field only applies to gateways of type 'SECURE_WEB_GATEWAY'. "allowGlobalAccess": True or False, # Optional. If true, the gateway will allow traffic from clients outside of the region where the gateway is located. This field is configurable only for gateways of type SECURE_WEB_GATEWAY. "certificateUrls": [ # Optional. A fully-qualified Certificates URL reference. The proxy presents a Certificate (selected based on SNI) when establishing a TLS connection. This feature only applies to gateways of type 'SECURE_WEB_GATEWAY'. "A String", @@ -337,6 +340,7 @@

Method Details

"addresses": [ # Optional. Zero or one IPv4 or IPv6 address on which the Gateway will receive the traffic. When no address is provided, an IP from the subnetwork is allocated This field only applies to gateways of type 'SECURE_WEB_GATEWAY'. Gateways of type 'OPEN_MESH' listen on 0.0.0.0 for IPv4 and :: for IPv6. "A String", ], + "allPorts": True or False, # Optional. If true, the Gateway will listen on all ports. This is mutually exclusive with the `ports` field. This field only applies to gateways of type 'SECURE_WEB_GATEWAY'. "allowGlobalAccess": True or False, # Optional. If true, the gateway will allow traffic from clients outside of the region where the gateway is located. This field is configurable only for gateways of type SECURE_WEB_GATEWAY. "certificateUrls": [ # Optional. A fully-qualified Certificates URL reference. The proxy presents a Certificate (selected based on SNI) when establishing a TLS connection. This feature only applies to gateways of type 'SECURE_WEB_GATEWAY'. "A String", diff --git a/docs/dyn/ondemandscanning_v1.projects.locations.scans.vulnerabilities.html b/docs/dyn/ondemandscanning_v1.projects.locations.scans.vulnerabilities.html index 7c451a924e..d905321fbe 100644 --- a/docs/dyn/ondemandscanning_v1.projects.locations.scans.vulnerabilities.html +++ b/docs/dyn/ondemandscanning_v1.projects.locations.scans.vulnerabilities.html @@ -110,6 +110,20 @@

Method Details

"occurrences": [ # The list of Vulnerability Occurrences resulting from a scan. { # An instance of an analysis type that has been found on a resource. "advisoryPublishTime": "A String", # The time this advisory was published by the source. + "aiSkillAnalysis": { # AISkillAnalysisOccurrence provides the results of an AI-based skill analysis. # Describes an AI skill analysis. + "findings": [ # Findings produced by the analysis. + { # Finding provides details for a single finding within an AISkillAnalysisOccurrence. + "category": "A String", # Category of the finding. + "description": "A String", # Detailed description of the finding. + "filePath": "A String", # Path to the file where the finding was detected. + "ruleId": "A String", # Unique identifier of the rule that produced this finding. + "severity": "A String", # Severity of the finding. + "snippet": "A String", # Code snippet relevant to the finding. + "title": "A String", # Title of the finding. + }, + ], + "skillName": "A String", # Name of the skill that produced this analysis. + }, "attestation": { # Occurrence that represents a single "attestation". The authenticity of an attestation can be verified using the attached signature. If the verifier trusts the public key of the signer, then verifying the signature is sufficient to establish trust. In this circumstance, the authority to which this attestation is attached is primarily useful for lookup (how to find this attestation if you already know the authority and artifact to be verified) and intent (for which authority this attestation was intended to sign. # Describes an attestation of an artifact. "jwts": [ # One or more JWTs encoding a self-contained attestation. Each JWT encodes the payload that it verifies within the JWT itself. Verifier implementation SHOULD ignore the `serialized_payload` field when verifying these JWTs. If only JWTs are present on this AttestationOccurrence, then the `serialized_payload` SHOULD be left empty. Each JWT SHOULD encode a claim specific to the `resource_uri` of this Occurrence, but this is not validated by Grafeas metadata API implementations. The JWT itself is opaque to Grafeas. { diff --git a/docs/dyn/ondemandscanning_v1beta1.projects.locations.scans.vulnerabilities.html b/docs/dyn/ondemandscanning_v1beta1.projects.locations.scans.vulnerabilities.html index f6ef77be99..e53b98219e 100644 --- a/docs/dyn/ondemandscanning_v1beta1.projects.locations.scans.vulnerabilities.html +++ b/docs/dyn/ondemandscanning_v1beta1.projects.locations.scans.vulnerabilities.html @@ -110,6 +110,20 @@

Method Details

"occurrences": [ # The list of Vulnerability Occurrences resulting from a scan. { # An instance of an analysis type that has been found on a resource. "advisoryPublishTime": "A String", # The time this advisory was published by the source. + "aiSkillAnalysis": { # AISkillAnalysisOccurrence provides the results of an AI-based skill analysis. # Describes an AI skill analysis. + "findings": [ # Findings produced by the analysis. + { # Finding provides details for a single finding within an AISkillAnalysisOccurrence. + "category": "A String", # Category of the finding. + "description": "A String", # Detailed description of the finding. + "filePath": "A String", # Path to the file where the finding was detected. + "ruleId": "A String", # Unique identifier of the rule that produced this finding. + "severity": "A String", # Severity of the finding. + "snippet": "A String", # Code snippet relevant to the finding. + "title": "A String", # Title of the finding. + }, + ], + "skillName": "A String", # Name of the skill that produced this analysis. + }, "attestation": { # Occurrence that represents a single "attestation". The authenticity of an attestation can be verified using the attached signature. If the verifier trusts the public key of the signer, then verifying the signature is sufficient to establish trust. In this circumstance, the authority to which this attestation is attached is primarily useful for lookup (how to find this attestation if you already know the authority and artifact to be verified) and intent (for which authority this attestation was intended to sign. # Describes an attestation of an artifact. "jwts": [ # One or more JWTs encoding a self-contained attestation. Each JWT encodes the payload that it verifies within the JWT itself. Verifier implementation SHOULD ignore the `serialized_payload` field when verifying these JWTs. If only JWTs are present on this AttestationOccurrence, then the `serialized_payload` SHOULD be left empty. Each JWT SHOULD encode a claim specific to the `resource_uri` of this Occurrence, but this is not validated by Grafeas metadata API implementations. The JWT itself is opaque to Grafeas. { diff --git a/docs/dyn/oracledatabase_v1.projects.locations.autonomousDatabases.html b/docs/dyn/oracledatabase_v1.projects.locations.autonomousDatabases.html index df32c7932f..41767ddf6e 100644 --- a/docs/dyn/oracledatabase_v1.projects.locations.autonomousDatabases.html +++ b/docs/dyn/oracledatabase_v1.projects.locations.autonomousDatabases.html @@ -132,7 +132,8 @@

Method Details

The object takes the form of: { # Details of the Autonomous Database resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabase/ - "adminPassword": "A String", # Optional. Immutable. The password for the default ADMIN user. + "adminPassword": "A String", # Optional. Immutable. The password for the default ADMIN user. Note: Only one of `admin_password_secret_version` or `admin_password` can be populated. + "adminPasswordSecretVersion": "A String", # Optional. Immutable. The resource name of a secret version in Secret Manager which contains the database admin user's password. Format: projects/{project}/secrets/{secret}/versions/{version}. Note: Only one of `admin_password_secret_version` or `admin_password` can be populated. "cidr": "A String", # Optional. Immutable. The subnet CIDR range for the Autonomous Database. "createTime": "A String", # Output only. The date and time that the Autonomous Database was created. "database": "A String", # Optional. Immutable. The name of the Autonomous Database. The database name must be unique in the project. The name must begin with a letter and can contain a maximum of 30 alphanumeric characters. @@ -233,11 +234,13 @@

Method Details

], "failedDataRecoveryDuration": "A String", # Output only. This field indicates the number of seconds of data loss during a Data Guard failover. "isAutoScalingEnabled": True or False, # Optional. Immutable. This field indicates if auto scaling is enabled for the Autonomous Database CPU core count. - "isLocalDataGuardEnabled": True or False, # Output only. This field indicates whether the Autonomous Database has local (in-region) Data Guard enabled. + "isLocalDataGuardEnabled": True or False, # Output only. Deprecated: Please use `local_data_guard_enabled` instead. This field indicates whether the Autonomous Database has local (in-region) Data Guard enabled. "isStorageAutoScalingEnabled": True or False, # Optional. Immutable. This field indicates if auto scaling is enabled for the Autonomous Database storage. "licenseType": "A String", # Required. Immutable. The license type used for the Autonomous Database. "lifecycleDetails": "A String", # Output only. The details of the current lifestyle state of the Autonomous Database. - "localAdgAutoFailoverMaxDataLossLimit": 42, # Output only. This field indicates the maximum data loss limit for an Autonomous Database, in seconds. + "localAdgAutoFailoverMaxDataLossLimit": 42, # Output only. Deprecated: Please use `local_adg_auto_failover_max_data_loss_limit_duration` instead. This field indicates the maximum data loss limit for an Autonomous Database, in seconds. + "localAdgAutoFailoverMaxDataLossLimitDuration": 42, # Optional. This field indicates the maximum data loss limit for an Autonomous Database, in seconds. + "localDataGuardEnabled": True or False, # Optional. Indicates whether the Autonomous Database has a local (in-region) standby database. Not applicable to cross-region Data Guard or dedicated Exadata infrastructure. "localDisasterRecoveryType": "A String", # Output only. This field indicates the local disaster recovery (DR) type of an Autonomous Database. "localStandbyDb": { # Autonomous Data Guard standby database details. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/AutonomousDatabaseStandbySummary # Output only. The details of the Autonomous Data Guard standby database. "dataGuardRoleChangedTime": "A String", # Output only. The date and time the Autonomous Data Guard role was switched for the standby Autonomous Database. @@ -454,7 +457,8 @@

Method Details

An object of the form: { # Details of the Autonomous Database resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabase/ - "adminPassword": "A String", # Optional. Immutable. The password for the default ADMIN user. + "adminPassword": "A String", # Optional. Immutable. The password for the default ADMIN user. Note: Only one of `admin_password_secret_version` or `admin_password` can be populated. + "adminPasswordSecretVersion": "A String", # Optional. Immutable. The resource name of a secret version in Secret Manager which contains the database admin user's password. Format: projects/{project}/secrets/{secret}/versions/{version}. Note: Only one of `admin_password_secret_version` or `admin_password` can be populated. "cidr": "A String", # Optional. Immutable. The subnet CIDR range for the Autonomous Database. "createTime": "A String", # Output only. The date and time that the Autonomous Database was created. "database": "A String", # Optional. Immutable. The name of the Autonomous Database. The database name must be unique in the project. The name must begin with a letter and can contain a maximum of 30 alphanumeric characters. @@ -555,11 +559,13 @@

Method Details

], "failedDataRecoveryDuration": "A String", # Output only. This field indicates the number of seconds of data loss during a Data Guard failover. "isAutoScalingEnabled": True or False, # Optional. Immutable. This field indicates if auto scaling is enabled for the Autonomous Database CPU core count. - "isLocalDataGuardEnabled": True or False, # Output only. This field indicates whether the Autonomous Database has local (in-region) Data Guard enabled. + "isLocalDataGuardEnabled": True or False, # Output only. Deprecated: Please use `local_data_guard_enabled` instead. This field indicates whether the Autonomous Database has local (in-region) Data Guard enabled. "isStorageAutoScalingEnabled": True or False, # Optional. Immutable. This field indicates if auto scaling is enabled for the Autonomous Database storage. "licenseType": "A String", # Required. Immutable. The license type used for the Autonomous Database. "lifecycleDetails": "A String", # Output only. The details of the current lifestyle state of the Autonomous Database. - "localAdgAutoFailoverMaxDataLossLimit": 42, # Output only. This field indicates the maximum data loss limit for an Autonomous Database, in seconds. + "localAdgAutoFailoverMaxDataLossLimit": 42, # Output only. Deprecated: Please use `local_adg_auto_failover_max_data_loss_limit_duration` instead. This field indicates the maximum data loss limit for an Autonomous Database, in seconds. + "localAdgAutoFailoverMaxDataLossLimitDuration": 42, # Optional. This field indicates the maximum data loss limit for an Autonomous Database, in seconds. + "localDataGuardEnabled": True or False, # Optional. Indicates whether the Autonomous Database has a local (in-region) standby database. Not applicable to cross-region Data Guard or dedicated Exadata infrastructure. "localDisasterRecoveryType": "A String", # Output only. This field indicates the local disaster recovery (DR) type of an Autonomous Database. "localStandbyDb": { # Autonomous Data Guard standby database details. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/AutonomousDatabaseStandbySummary # Output only. The details of the Autonomous Data Guard standby database. "dataGuardRoleChangedTime": "A String", # Output only. The date and time the Autonomous Data Guard role was switched for the standby Autonomous Database. @@ -646,7 +652,8 @@

Method Details

{ # The response for `AutonomousDatabase.List`. "autonomousDatabases": [ # The list of Autonomous Databases. { # Details of the Autonomous Database resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabase/ - "adminPassword": "A String", # Optional. Immutable. The password for the default ADMIN user. + "adminPassword": "A String", # Optional. Immutable. The password for the default ADMIN user. Note: Only one of `admin_password_secret_version` or `admin_password` can be populated. + "adminPasswordSecretVersion": "A String", # Optional. Immutable. The resource name of a secret version in Secret Manager which contains the database admin user's password. Format: projects/{project}/secrets/{secret}/versions/{version}. Note: Only one of `admin_password_secret_version` or `admin_password` can be populated. "cidr": "A String", # Optional. Immutable. The subnet CIDR range for the Autonomous Database. "createTime": "A String", # Output only. The date and time that the Autonomous Database was created. "database": "A String", # Optional. Immutable. The name of the Autonomous Database. The database name must be unique in the project. The name must begin with a letter and can contain a maximum of 30 alphanumeric characters. @@ -747,11 +754,13 @@

Method Details

], "failedDataRecoveryDuration": "A String", # Output only. This field indicates the number of seconds of data loss during a Data Guard failover. "isAutoScalingEnabled": True or False, # Optional. Immutable. This field indicates if auto scaling is enabled for the Autonomous Database CPU core count. - "isLocalDataGuardEnabled": True or False, # Output only. This field indicates whether the Autonomous Database has local (in-region) Data Guard enabled. + "isLocalDataGuardEnabled": True or False, # Output only. Deprecated: Please use `local_data_guard_enabled` instead. This field indicates whether the Autonomous Database has local (in-region) Data Guard enabled. "isStorageAutoScalingEnabled": True or False, # Optional. Immutable. This field indicates if auto scaling is enabled for the Autonomous Database storage. "licenseType": "A String", # Required. Immutable. The license type used for the Autonomous Database. "lifecycleDetails": "A String", # Output only. The details of the current lifestyle state of the Autonomous Database. - "localAdgAutoFailoverMaxDataLossLimit": 42, # Output only. This field indicates the maximum data loss limit for an Autonomous Database, in seconds. + "localAdgAutoFailoverMaxDataLossLimit": 42, # Output only. Deprecated: Please use `local_adg_auto_failover_max_data_loss_limit_duration` instead. This field indicates the maximum data loss limit for an Autonomous Database, in seconds. + "localAdgAutoFailoverMaxDataLossLimitDuration": 42, # Optional. This field indicates the maximum data loss limit for an Autonomous Database, in seconds. + "localDataGuardEnabled": True or False, # Optional. Indicates whether the Autonomous Database has a local (in-region) standby database. Not applicable to cross-region Data Guard or dedicated Exadata infrastructure. "localDisasterRecoveryType": "A String", # Output only. This field indicates the local disaster recovery (DR) type of an Autonomous Database. "localStandbyDb": { # Autonomous Data Guard standby database details. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/AutonomousDatabaseStandbySummary # Output only. The details of the Autonomous Data Guard standby database. "dataGuardRoleChangedTime": "A String", # Output only. The date and time the Autonomous Data Guard role was switched for the standby Autonomous Database. @@ -844,7 +853,8 @@

Method Details

The object takes the form of: { # Details of the Autonomous Database resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabase/ - "adminPassword": "A String", # Optional. Immutable. The password for the default ADMIN user. + "adminPassword": "A String", # Optional. Immutable. The password for the default ADMIN user. Note: Only one of `admin_password_secret_version` or `admin_password` can be populated. + "adminPasswordSecretVersion": "A String", # Optional. Immutable. The resource name of a secret version in Secret Manager which contains the database admin user's password. Format: projects/{project}/secrets/{secret}/versions/{version}. Note: Only one of `admin_password_secret_version` or `admin_password` can be populated. "cidr": "A String", # Optional. Immutable. The subnet CIDR range for the Autonomous Database. "createTime": "A String", # Output only. The date and time that the Autonomous Database was created. "database": "A String", # Optional. Immutable. The name of the Autonomous Database. The database name must be unique in the project. The name must begin with a letter and can contain a maximum of 30 alphanumeric characters. @@ -945,11 +955,13 @@

Method Details

], "failedDataRecoveryDuration": "A String", # Output only. This field indicates the number of seconds of data loss during a Data Guard failover. "isAutoScalingEnabled": True or False, # Optional. Immutable. This field indicates if auto scaling is enabled for the Autonomous Database CPU core count. - "isLocalDataGuardEnabled": True or False, # Output only. This field indicates whether the Autonomous Database has local (in-region) Data Guard enabled. + "isLocalDataGuardEnabled": True or False, # Output only. Deprecated: Please use `local_data_guard_enabled` instead. This field indicates whether the Autonomous Database has local (in-region) Data Guard enabled. "isStorageAutoScalingEnabled": True or False, # Optional. Immutable. This field indicates if auto scaling is enabled for the Autonomous Database storage. "licenseType": "A String", # Required. Immutable. The license type used for the Autonomous Database. "lifecycleDetails": "A String", # Output only. The details of the current lifestyle state of the Autonomous Database. - "localAdgAutoFailoverMaxDataLossLimit": 42, # Output only. This field indicates the maximum data loss limit for an Autonomous Database, in seconds. + "localAdgAutoFailoverMaxDataLossLimit": 42, # Output only. Deprecated: Please use `local_adg_auto_failover_max_data_loss_limit_duration` instead. This field indicates the maximum data loss limit for an Autonomous Database, in seconds. + "localAdgAutoFailoverMaxDataLossLimitDuration": 42, # Optional. This field indicates the maximum data loss limit for an Autonomous Database, in seconds. + "localDataGuardEnabled": True or False, # Optional. Indicates whether the Autonomous Database has a local (in-region) standby database. Not applicable to cross-region Data Guard or dedicated Exadata infrastructure. "localDisasterRecoveryType": "A String", # Output only. This field indicates the local disaster recovery (DR) type of an Autonomous Database. "localStandbyDb": { # Autonomous Data Guard standby database details. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/AutonomousDatabaseStandbySummary # Output only. The details of the Autonomous Data Guard standby database. "dataGuardRoleChangedTime": "A String", # Output only. The date and time the Autonomous Data Guard role was switched for the standby Autonomous Database. diff --git a/docs/dyn/oracledatabase_v1.projects.locations.databases.html b/docs/dyn/oracledatabase_v1.projects.locations.databases.html index 1d55fc739b..5b414889e3 100644 --- a/docs/dyn/oracledatabase_v1.projects.locations.databases.html +++ b/docs/dyn/oracledatabase_v1.projects.locations.databases.html @@ -107,7 +107,8 @@

Method Details

An object of the form: { # Details of the Database resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/Database/ - "adminPassword": "A String", # Optional. The password for the default ADMIN user. + "adminPassword": "A String", # Optional. The password for the default ADMIN user. Note: Only one of `admin_password_secret_version` or `admin_password` can be populated. + "adminPasswordSecretVersion": "A String", # Optional. The resource name of a secret version in Secret Manager which contains the database admin user's password. Format: projects/{project}/secrets/{secret}/versions/{version}. Note: Only one of `admin_password_secret_version` or `admin_password` can be populated. "characterSet": "A String", # Optional. The character set for the database. The default is AL32UTF8. "createTime": "A String", # Output only. The date and time that the Database was created. "databaseId": "A String", # Optional. The database ID of the Database. @@ -142,7 +143,8 @@

Method Details

"dbVersion": "A String", # Required. The Oracle Database version. "state": "A String", # Output only. State of the Database. }, - "tdeWalletPassword": "A String", # Optional. The TDE wallet password for the database. + "tdeWalletPassword": "A String", # Optional. The TDE wallet password for the database. Note: Only one of `tde_wallet_password_secret_version` or `tde_wallet_password` can be populated. + "tdeWalletPasswordSecretVersion": "A String", # Optional. The resource name of a secret version in Secret Manager which contains the TDE wallet password for the database. Format: projects/{project}/secrets/{secret}/versions/{version}. Note: Only one of `tde_wallet_password_secret_version` or `tde_wallet_password` can be populated. }
@@ -166,7 +168,8 @@

Method Details

{ # The response for `Database.List`. "databases": [ # The list of Databases. { # Details of the Database resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/Database/ - "adminPassword": "A String", # Optional. The password for the default ADMIN user. + "adminPassword": "A String", # Optional. The password for the default ADMIN user. Note: Only one of `admin_password_secret_version` or `admin_password` can be populated. + "adminPasswordSecretVersion": "A String", # Optional. The resource name of a secret version in Secret Manager which contains the database admin user's password. Format: projects/{project}/secrets/{secret}/versions/{version}. Note: Only one of `admin_password_secret_version` or `admin_password` can be populated. "characterSet": "A String", # Optional. The character set for the database. The default is AL32UTF8. "createTime": "A String", # Output only. The date and time that the Database was created. "databaseId": "A String", # Optional. The database ID of the Database. @@ -201,7 +204,8 @@

Method Details

"dbVersion": "A String", # Required. The Oracle Database version. "state": "A String", # Output only. State of the Database. }, - "tdeWalletPassword": "A String", # Optional. The TDE wallet password for the database. + "tdeWalletPassword": "A String", # Optional. The TDE wallet password for the database. Note: Only one of `tde_wallet_password_secret_version` or `tde_wallet_password` can be populated. + "tdeWalletPasswordSecretVersion": "A String", # Optional. The resource name of a secret version in Secret Manager which contains the TDE wallet password for the database. Format: projects/{project}/secrets/{secret}/versions/{version}. Note: Only one of `tde_wallet_password_secret_version` or `tde_wallet_password` can be populated. }, ], "nextPageToken": "A String", # A token identifying a page of results the server should return. diff --git a/docs/dyn/oracledatabase_v1.projects.locations.dbSystems.html b/docs/dyn/oracledatabase_v1.projects.locations.dbSystems.html index e48c7485ad..4585106502 100644 --- a/docs/dyn/oracledatabase_v1.projects.locations.dbSystems.html +++ b/docs/dyn/oracledatabase_v1.projects.locations.dbSystems.html @@ -130,7 +130,8 @@

Method Details

"databaseEdition": "A String", # Required. The database edition of the DbSystem. "dbHome": { # Details of the Database Home resource. # Optional. Details for creating a Database Home. "database": { # Details of the Database resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/Database/ # Required. The Database resource. - "adminPassword": "A String", # Optional. The password for the default ADMIN user. + "adminPassword": "A String", # Optional. The password for the default ADMIN user. Note: Only one of `admin_password_secret_version` or `admin_password` can be populated. + "adminPasswordSecretVersion": "A String", # Optional. The resource name of a secret version in Secret Manager which contains the database admin user's password. Format: projects/{project}/secrets/{secret}/versions/{version}. Note: Only one of `admin_password_secret_version` or `admin_password` can be populated. "characterSet": "A String", # Optional. The character set for the database. The default is AL32UTF8. "createTime": "A String", # Output only. The date and time that the Database was created. "databaseId": "A String", # Optional. The database ID of the Database. @@ -165,7 +166,8 @@

Method Details

"dbVersion": "A String", # Required. The Oracle Database version. "state": "A String", # Output only. State of the Database. }, - "tdeWalletPassword": "A String", # Optional. The TDE wallet password for the database. + "tdeWalletPassword": "A String", # Optional. The TDE wallet password for the database. Note: Only one of `tde_wallet_password_secret_version` or `tde_wallet_password` can be populated. + "tdeWalletPasswordSecretVersion": "A String", # Optional. The resource name of a secret version in Secret Manager which contains the TDE wallet password for the database. Format: projects/{project}/secrets/{secret}/versions/{version}. Note: Only one of `tde_wallet_password_secret_version` or `tde_wallet_password` can be populated. }, "dbVersion": "A String", # Required. A valid Oracle Database version. For a list of supported versions, use the ListDbVersions operation. "displayName": "A String", # Optional. The display name for the Database Home. The name does not have to be unique within your project. @@ -300,7 +302,8 @@

Method Details

"databaseEdition": "A String", # Required. The database edition of the DbSystem. "dbHome": { # Details of the Database Home resource. # Optional. Details for creating a Database Home. "database": { # Details of the Database resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/Database/ # Required. The Database resource. - "adminPassword": "A String", # Optional. The password for the default ADMIN user. + "adminPassword": "A String", # Optional. The password for the default ADMIN user. Note: Only one of `admin_password_secret_version` or `admin_password` can be populated. + "adminPasswordSecretVersion": "A String", # Optional. The resource name of a secret version in Secret Manager which contains the database admin user's password. Format: projects/{project}/secrets/{secret}/versions/{version}. Note: Only one of `admin_password_secret_version` or `admin_password` can be populated. "characterSet": "A String", # Optional. The character set for the database. The default is AL32UTF8. "createTime": "A String", # Output only. The date and time that the Database was created. "databaseId": "A String", # Optional. The database ID of the Database. @@ -335,7 +338,8 @@

Method Details

"dbVersion": "A String", # Required. The Oracle Database version. "state": "A String", # Output only. State of the Database. }, - "tdeWalletPassword": "A String", # Optional. The TDE wallet password for the database. + "tdeWalletPassword": "A String", # Optional. The TDE wallet password for the database. Note: Only one of `tde_wallet_password_secret_version` or `tde_wallet_password` can be populated. + "tdeWalletPasswordSecretVersion": "A String", # Optional. The resource name of a secret version in Secret Manager which contains the TDE wallet password for the database. Format: projects/{project}/secrets/{secret}/versions/{version}. Note: Only one of `tde_wallet_password_secret_version` or `tde_wallet_password` can be populated. }, "dbVersion": "A String", # Required. A valid Oracle Database version. For a list of supported versions, use the ListDbVersions operation. "displayName": "A String", # Optional. The display name for the Database Home. The name does not have to be unique within your project. @@ -410,7 +414,8 @@

Method Details

"databaseEdition": "A String", # Required. The database edition of the DbSystem. "dbHome": { # Details of the Database Home resource. # Optional. Details for creating a Database Home. "database": { # Details of the Database resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/Database/ # Required. The Database resource. - "adminPassword": "A String", # Optional. The password for the default ADMIN user. + "adminPassword": "A String", # Optional. The password for the default ADMIN user. Note: Only one of `admin_password_secret_version` or `admin_password` can be populated. + "adminPasswordSecretVersion": "A String", # Optional. The resource name of a secret version in Secret Manager which contains the database admin user's password. Format: projects/{project}/secrets/{secret}/versions/{version}. Note: Only one of `admin_password_secret_version` or `admin_password` can be populated. "characterSet": "A String", # Optional. The character set for the database. The default is AL32UTF8. "createTime": "A String", # Output only. The date and time that the Database was created. "databaseId": "A String", # Optional. The database ID of the Database. @@ -445,7 +450,8 @@

Method Details

"dbVersion": "A String", # Required. The Oracle Database version. "state": "A String", # Output only. State of the Database. }, - "tdeWalletPassword": "A String", # Optional. The TDE wallet password for the database. + "tdeWalletPassword": "A String", # Optional. The TDE wallet password for the database. Note: Only one of `tde_wallet_password_secret_version` or `tde_wallet_password` can be populated. + "tdeWalletPasswordSecretVersion": "A String", # Optional. The resource name of a secret version in Secret Manager which contains the TDE wallet password for the database. Format: projects/{project}/secrets/{secret}/versions/{version}. Note: Only one of `tde_wallet_password_secret_version` or `tde_wallet_password` can be populated. }, "dbVersion": "A String", # Required. A valid Oracle Database version. For a list of supported versions, use the ListDbVersions operation. "displayName": "A String", # Optional. The display name for the Database Home. The name does not have to be unique within your project. diff --git a/docs/dyn/parametermanager_v1.projects.locations.html b/docs/dyn/parametermanager_v1.projects.locations.html index ccab0a993f..3033ea7b7a 100644 --- a/docs/dyn/parametermanager_v1.projects.locations.html +++ b/docs/dyn/parametermanager_v1.projects.locations.html @@ -87,7 +87,7 @@

Instance Methods

Gets information about a location.

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

-

Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.

+

Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.

list_next()

Retrieves the next page of results.

@@ -126,7 +126,7 @@

Method Details

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
+  
Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
diff --git a/docs/dyn/redis_v1.projects.locations.clusters.html b/docs/dyn/redis_v1.projects.locations.clusters.html
index a7805a1044..d68bba2770 100644
--- a/docs/dyn/redis_v1.projects.locations.clusters.html
+++ b/docs/dyn/redis_v1.projects.locations.clusters.html
@@ -74,6 +74,14 @@
 
 

Google Cloud Memorystore for Redis API . projects . locations . clusters

Instance Methods

+

+ tokenAuthUsers() +

+

Returns the tokenAuthUsers Resource.

+ +

+ addTokenAuthUser(cluster, body=None, x__xgafv=None)

+

Adds a token auth user for a token based auth enabled cluster.

backup(name, body=None, x__xgafv=None)

Backup Redis Cluster. If this is the first time a backup is being created, a backup collection will be created at the backend, and this backup belongs to this collection. Both collection and backup will have a resource name. Backup will be executed for each shard. A replica (primary if nonHA) will be selected to perform the execution. Backup call will be rejected if there is an ongoing backup or update operation. Be aware that during preview, if the cluster's internal software version is too old, critical update will be performed before actual backup. Once the internal software version is updated to the minimum version required by the backup feature, subsequent backups will not require critical update. After preview, there will be no critical update needed for backup.

@@ -105,6 +113,48 @@

Instance Methods

rescheduleClusterMaintenance(name, body=None, x__xgafv=None)

Reschedules upcoming maintenance event.

Method Details

+
+ addTokenAuthUser(cluster, body=None, x__xgafv=None) +
Adds a token auth user for a token based auth enabled cluster.
+
+Args:
+  cluster: string, Required. The cluster resource that this token auth user will be added for. Format: projects/{project}/locations/{location}/clusters/{cluster} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for AddTokenAuthUser.
+  "tokenAuthUser": "A String", # Required. The id of the token auth user to add.
+}
+
+  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": { # { `createTime`: The time the operation was created. `endTime`: The time the operation finished running. `target`: Server-defined resource path for the target of the operation. `verb`: Name of the verb executed by the operation. `statusDetail`: Human-readable status of the operation, if any. `cancelRequested`: Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. `apiVersion`: API version used to start the operation. }
+    "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, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+
backup(name, body=None, x__xgafv=None)
Backup Redis Cluster. If this is the first time a backup is being created, a backup collection will be created at the backend, and this backup belongs to this collection. Both collection and backup will have a resource name. Backup will be executed for each shard. A replica (primary if nonHA) will be selected to perform the execution. Backup call will be rejected if there is an ongoing backup or update operation. Be aware that during preview, if the cluster's internal software version is too old, critical update will be performed before actual backup. Once the internal software version is updated to the minimum version required by the backup feature, subsequent backups will not require critical update. After preview, there will be no critical update needed for backup.
diff --git a/docs/dyn/redis_v1.projects.locations.clusters.tokenAuthUsers.authTokens.html b/docs/dyn/redis_v1.projects.locations.clusters.tokenAuthUsers.authTokens.html
new file mode 100644
index 0000000000..8fed9080d8
--- /dev/null
+++ b/docs/dyn/redis_v1.projects.locations.clusters.tokenAuthUsers.authTokens.html
@@ -0,0 +1,203 @@
+
+
+
+

Google Cloud Memorystore for Redis API . projects . locations . clusters . tokenAuthUsers . authTokens

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

Removes a auth token for a user of a token based auth enabled instance.

+

+ get(name, x__xgafv=None)

+

Gets a specific auth token for a specific token auth user.

+

+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists all the auth tokens for a specific token auth user.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) +
Removes a auth token for a user of a token based auth enabled instance.
+
+Args:
+  name: string, Required. The name of the token auth user resource that this auth token will be deleted from. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user}/authTokens/{auth_token} (required)
+  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": { # { `createTime`: The time the operation was created. `endTime`: The time the operation finished running. `target`: Server-defined resource path for the target of the operation. `verb`: Name of the verb executed by the operation. `statusDetail`: Human-readable status of the operation, if any. `cancelRequested`: Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. `apiVersion`: API version used to start the operation. }
+    "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, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ get(name, x__xgafv=None) +
Gets a specific auth token for a specific token auth user.
+
+Args:
+  name: string, Required. The name of auth token for a token based auth enabled cluster. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user}/authTokens/{auth_token} (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Auth token for the cluster.
+  "createTime": "A String", # Output only. Create time of the auth token.
+  "name": "A String", # Identifier. Name of the auth token. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user}/authTokens/{auth_token}
+  "state": "A String", # Output only. State of the auth token.
+  "token": "A String", # Output only. The service generated authentication token used to connect to the Redis cluster.
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists all the auth tokens for a specific token auth user.
+
+Args:
+  parent: string, Required. The parent resource that this auth token will be listed for. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user} (required)
+  filter: string, Optional. Expression for filtering results.
+  orderBy: string, Optional. Sort results by a defined order.
+  pageSize: integer, Optional. The maximum number of items to return. The maximum value is 1000; values above 1000 will be coerced to 1000. If not specified, a default value of 1000 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's `next_page_token` to determine if there are more clusters left to be queried.
+  pageToken: string, Optional. The `next_page_token` value returned from a previous [ListTokenAuthUsers] request, if any.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for ListAuthTokens.
+  "authTokens": [ # A list of auth tokens in the project.
+    { # Auth token for the cluster.
+      "createTime": "A String", # Output only. Create time of the auth token.
+      "name": "A String", # Identifier. Name of the auth token. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user}/authTokens/{auth_token}
+      "state": "A String", # Output only. State of the auth token.
+      "token": "A String", # Output only. The service generated authentication token used to connect to the Redis cluster.
+    },
+  ],
+  "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
+  "unreachable": [ # Unordered list. Auth tokens that could not be reached.
+    "A String",
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/redis_v1.projects.locations.clusters.tokenAuthUsers.html b/docs/dyn/redis_v1.projects.locations.clusters.tokenAuthUsers.html new file mode 100644 index 0000000000..b137ea90aa --- /dev/null +++ b/docs/dyn/redis_v1.projects.locations.clusters.tokenAuthUsers.html @@ -0,0 +1,256 @@ + + + +

Google Cloud Memorystore for Redis API . projects . locations . clusters . tokenAuthUsers

+

Instance Methods

+

+ authTokens() +

+

Returns the authTokens Resource.

+ +

+ addAuthToken(tokenAuthUser, body=None, x__xgafv=None)

+

Adds a auth token for a user of a token based auth enabled cluster.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, force=None, requestId=None, x__xgafv=None)

+

Deletes a token auth user for a token based auth enabled cluster.

+

+ get(name, x__xgafv=None)

+

Gets a specific token auth user for a basic auth enabled cluster.

+

+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists all the token auth users for a token based auth enabled cluster.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ addAuthToken(tokenAuthUser, body=None, x__xgafv=None) +
Adds a auth token for a user of a token based auth enabled cluster.
+
+Args:
+  tokenAuthUser: string, Required. The name of the token auth user resource that this auth token will be added for. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for AddAuthToken.
+  "authToken": { # Auth token for the cluster. # Required. The auth token to add.
+    "createTime": "A String", # Output only. Create time of the auth token.
+    "name": "A String", # Identifier. Name of the auth token. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user}/authTokens/{auth_token}
+    "state": "A String", # Output only. State of the auth token.
+    "token": "A String", # Output only. The service generated authentication token used to connect to the Redis cluster.
+  },
+}
+
+  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": { # { `createTime`: The time the operation was created. `endTime`: The time the operation finished running. `target`: Server-defined resource path for the target of the operation. `verb`: Name of the verb executed by the operation. `statusDetail`: Human-readable status of the operation, if any. `cancelRequested`: Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. `apiVersion`: API version used to start the operation. }
+    "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, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ delete(name, force=None, requestId=None, x__xgafv=None) +
Deletes a token auth user for a token based auth enabled cluster.
+
+Args:
+  name: string, Required. The name of the token auth user to delete. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user} (required)
+  force: boolean, Optional. If set to true, any child auth tokens of this user will also be deleted. Otherwise, the request will only work if the user has no auth tokens.
+  requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+  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": { # { `createTime`: The time the operation was created. `endTime`: The time the operation finished running. `target`: Server-defined resource path for the target of the operation. `verb`: Name of the verb executed by the operation. `statusDetail`: Human-readable status of the operation, if any. `cancelRequested`: Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. `apiVersion`: API version used to start the operation. }
+    "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, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ get(name, x__xgafv=None) +
Gets a specific token auth user for a basic auth enabled cluster.
+
+Args:
+  name: string, Required. The name of token auth user for a token based auth enabled cluster. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user} (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents a token based auth user for the cluster.
+  "name": "A String", # Identifier. The resource name of the token based auth user. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user}
+  "state": "A String", # Output only. The state of the token based auth user.
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists all the token auth users for a token based auth enabled cluster.
+
+Args:
+  parent: string, Required. The parent resource that this token based auth user will be listed for. Format: projects/{project}/locations/{location}/clusters/{cluster} (required)
+  filter: string, Optional. Expression for filtering results.
+  orderBy: string, Optional. Sort results by a defined order.
+  pageSize: integer, Optional. The maximum number of items to return. If not specified, a default value of 1000 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's The maximum value is 1000; values above 1000 will be coerced to 1000. `next_page_token` to determine if there are more clusters left to be queried.
+  pageToken: string, Optional. The `next_page_token` value returned from a previous [ListTokenAuthUsers] request, if any.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for ListTokenAuthUsers.
+  "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
+  "tokenAuthUsers": [ # A list of token auth users in the project.
+    { # Represents a token based auth user for the cluster.
+      "name": "A String", # Identifier. The resource name of the token based auth user. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user}
+      "state": "A String", # Output only. The state of the token based auth user.
+    },
+  ],
+  "unreachable": [ # Unordered list. Token auth users that could not be reached.
+    "A String",
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/redis_v1beta1.projects.locations.clusters.html b/docs/dyn/redis_v1beta1.projects.locations.clusters.html index 10689f6317..d7c9890966 100644 --- a/docs/dyn/redis_v1beta1.projects.locations.clusters.html +++ b/docs/dyn/redis_v1beta1.projects.locations.clusters.html @@ -74,6 +74,14 @@

Google Cloud Memorystore for Redis API . projects . locations . clusters

Instance Methods

+

+ tokenAuthUsers() +

+

Returns the tokenAuthUsers Resource.

+ +

+ addTokenAuthUser(cluster, body=None, x__xgafv=None)

+

Adds a token auth user for a token based auth enabled cluster.

backup(name, body=None, x__xgafv=None)

Backup Redis Cluster. If this is the first time a backup is being created, a backup collection will be created at the backend, and this backup belongs to this collection. Both collection and backup will have a resource name. Backup will be executed for each shard. A replica (primary if nonHA) will be selected to perform the execution. Backup call will be rejected if there is an ongoing backup or update operation. Be aware that during preview, if the cluster's internal software version is too old, critical update will be performed before actual backup. Once the internal software version is updated to the minimum version required by the backup feature, subsequent backups will not require critical update. After preview, there will be no critical update needed for backup.

@@ -105,6 +113,48 @@

Instance Methods

rescheduleClusterMaintenance(name, body=None, x__xgafv=None)

Reschedules upcoming maintenance event.

Method Details

+
+ addTokenAuthUser(cluster, body=None, x__xgafv=None) +
Adds a token auth user for a token based auth enabled cluster.
+
+Args:
+  cluster: string, Required. The cluster resource that this token auth user will be added for. Format: projects/{project}/locations/{location}/clusters/{cluster} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for AddTokenAuthUser.
+  "tokenAuthUser": "A String", # Required. The id of the token auth user to add.
+}
+
+  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": { # { `createTime`: The time the operation was created. `endTime`: The time the operation finished running. `target`: Server-defined resource path for the target of the operation. `verb`: Name of the verb executed by the operation. `statusDetail`: Human-readable status of the operation, if any. `cancelRequested`: Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. `apiVersion`: API version used to start the operation. }
+    "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, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+
backup(name, body=None, x__xgafv=None)
Backup Redis Cluster. If this is the first time a backup is being created, a backup collection will be created at the backend, and this backup belongs to this collection. Both collection and backup will have a resource name. Backup will be executed for each shard. A replica (primary if nonHA) will be selected to perform the execution. Backup call will be rejected if there is an ongoing backup or update operation. Be aware that during preview, if the cluster's internal software version is too old, critical update will be performed before actual backup. Once the internal software version is updated to the minimum version required by the backup feature, subsequent backups will not require critical update. After preview, there will be no critical update needed for backup.
diff --git a/docs/dyn/redis_v1beta1.projects.locations.clusters.tokenAuthUsers.authTokens.html b/docs/dyn/redis_v1beta1.projects.locations.clusters.tokenAuthUsers.authTokens.html
new file mode 100644
index 0000000000..34eee29e87
--- /dev/null
+++ b/docs/dyn/redis_v1beta1.projects.locations.clusters.tokenAuthUsers.authTokens.html
@@ -0,0 +1,203 @@
+
+
+
+

Google Cloud Memorystore for Redis API . projects . locations . clusters . tokenAuthUsers . authTokens

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

Removes a auth token for a user of a token based auth enabled instance.

+

+ get(name, x__xgafv=None)

+

Gets a specific auth token for a specific token auth user.

+

+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists all the auth tokens for a specific token auth user.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) +
Removes a auth token for a user of a token based auth enabled instance.
+
+Args:
+  name: string, Required. The name of the token auth user resource that this auth token will be deleted from. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user}/authTokens/{auth_token} (required)
+  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": { # { `createTime`: The time the operation was created. `endTime`: The time the operation finished running. `target`: Server-defined resource path for the target of the operation. `verb`: Name of the verb executed by the operation. `statusDetail`: Human-readable status of the operation, if any. `cancelRequested`: Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. `apiVersion`: API version used to start the operation. }
+    "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, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ get(name, x__xgafv=None) +
Gets a specific auth token for a specific token auth user.
+
+Args:
+  name: string, Required. The name of auth token for a token based auth enabled cluster. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user}/authTokens/{auth_token} (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Auth token for the cluster.
+  "createTime": "A String", # Output only. Create time of the auth token.
+  "name": "A String", # Identifier. Name of the auth token. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user}/authTokens/{auth_token}
+  "state": "A String", # Output only. State of the auth token.
+  "token": "A String", # Output only. The service generated authentication token used to connect to the Redis cluster.
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists all the auth tokens for a specific token auth user.
+
+Args:
+  parent: string, Required. The parent resource that this auth token will be listed for. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user} (required)
+  filter: string, Optional. Expression for filtering results.
+  orderBy: string, Optional. Sort results by a defined order.
+  pageSize: integer, Optional. The maximum number of items to return. The maximum value is 1000; values above 1000 will be coerced to 1000. If not specified, a default value of 1000 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's `next_page_token` to determine if there are more clusters left to be queried.
+  pageToken: string, Optional. The `next_page_token` value returned from a previous [ListTokenAuthUsers] request, if any.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for ListAuthTokens.
+  "authTokens": [ # A list of auth tokens in the project.
+    { # Auth token for the cluster.
+      "createTime": "A String", # Output only. Create time of the auth token.
+      "name": "A String", # Identifier. Name of the auth token. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user}/authTokens/{auth_token}
+      "state": "A String", # Output only. State of the auth token.
+      "token": "A String", # Output only. The service generated authentication token used to connect to the Redis cluster.
+    },
+  ],
+  "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
+  "unreachable": [ # Unordered list. Auth tokens that could not be reached.
+    "A String",
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/redis_v1beta1.projects.locations.clusters.tokenAuthUsers.html b/docs/dyn/redis_v1beta1.projects.locations.clusters.tokenAuthUsers.html new file mode 100644 index 0000000000..a2d871e3ec --- /dev/null +++ b/docs/dyn/redis_v1beta1.projects.locations.clusters.tokenAuthUsers.html @@ -0,0 +1,256 @@ + + + +

Google Cloud Memorystore for Redis API . projects . locations . clusters . tokenAuthUsers

+

Instance Methods

+

+ authTokens() +

+

Returns the authTokens Resource.

+ +

+ addAuthToken(tokenAuthUser, body=None, x__xgafv=None)

+

Adds a auth token for a user of a token based auth enabled cluster.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, force=None, requestId=None, x__xgafv=None)

+

Deletes a token auth user for a token based auth enabled cluster.

+

+ get(name, x__xgafv=None)

+

Gets a specific token auth user for a basic auth enabled cluster.

+

+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists all the token auth users for a token based auth enabled cluster.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ addAuthToken(tokenAuthUser, body=None, x__xgafv=None) +
Adds a auth token for a user of a token based auth enabled cluster.
+
+Args:
+  tokenAuthUser: string, Required. The name of the token auth user resource that this auth token will be added for. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for AddAuthToken.
+  "authToken": { # Auth token for the cluster. # Required. The auth token to add.
+    "createTime": "A String", # Output only. Create time of the auth token.
+    "name": "A String", # Identifier. Name of the auth token. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user}/authTokens/{auth_token}
+    "state": "A String", # Output only. State of the auth token.
+    "token": "A String", # Output only. The service generated authentication token used to connect to the Redis cluster.
+  },
+}
+
+  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": { # { `createTime`: The time the operation was created. `endTime`: The time the operation finished running. `target`: Server-defined resource path for the target of the operation. `verb`: Name of the verb executed by the operation. `statusDetail`: Human-readable status of the operation, if any. `cancelRequested`: Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. `apiVersion`: API version used to start the operation. }
+    "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, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ delete(name, force=None, requestId=None, x__xgafv=None) +
Deletes a token auth user for a token based auth enabled cluster.
+
+Args:
+  name: string, Required. The name of the token auth user to delete. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user} (required)
+  force: boolean, Optional. If set to true, any child auth tokens of this user will also be deleted. Otherwise, the request will only work if the user has no auth tokens.
+  requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+  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": { # { `createTime`: The time the operation was created. `endTime`: The time the operation finished running. `target`: Server-defined resource path for the target of the operation. `verb`: Name of the verb executed by the operation. `statusDetail`: Human-readable status of the operation, if any. `cancelRequested`: Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. `apiVersion`: API version used to start the operation. }
+    "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, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ get(name, x__xgafv=None) +
Gets a specific token auth user for a basic auth enabled cluster.
+
+Args:
+  name: string, Required. The name of token auth user for a token based auth enabled cluster. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user} (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents a token based auth user for the cluster.
+  "name": "A String", # Identifier. The resource name of the token based auth user. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user}
+  "state": "A String", # Output only. The state of the token based auth user.
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists all the token auth users for a token based auth enabled cluster.
+
+Args:
+  parent: string, Required. The parent resource that this token based auth user will be listed for. Format: projects/{project}/locations/{location}/clusters/{cluster} (required)
+  filter: string, Optional. Expression for filtering results.
+  orderBy: string, Optional. Sort results by a defined order.
+  pageSize: integer, Optional. The maximum number of items to return. If not specified, a default value of 1000 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's The maximum value is 1000; values above 1000 will be coerced to 1000. `next_page_token` to determine if there are more clusters left to be queried.
+  pageToken: string, Optional. The `next_page_token` value returned from a previous [ListTokenAuthUsers] request, if any.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for ListTokenAuthUsers.
+  "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
+  "tokenAuthUsers": [ # A list of token auth users in the project.
+    { # Represents a token based auth user for the cluster.
+      "name": "A String", # Identifier. The resource name of the token based auth user. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user}
+      "state": "A String", # Output only. The state of the token based auth user.
+    },
+  ],
+  "unreachable": [ # Unordered list. Token auth users that could not be reached.
+    "A String",
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/saasservicemgmt_v1.projects.locations.html b/docs/dyn/saasservicemgmt_v1.projects.locations.html index 5a7e1cd0c4..b8d752e5b6 100644 --- a/docs/dyn/saasservicemgmt_v1.projects.locations.html +++ b/docs/dyn/saasservicemgmt_v1.projects.locations.html @@ -122,7 +122,7 @@

Instance Methods

Gets information about a location.

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

-

Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.

+

Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.

list_next()

Retrieves the next page of results.

@@ -161,7 +161,7 @@

Method Details

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
+  
Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
diff --git a/docs/dyn/saasservicemgmt_v1.projects.locations.rollouts.html b/docs/dyn/saasservicemgmt_v1.projects.locations.rollouts.html
index 91af11e946..94ac4c1db4 100644
--- a/docs/dyn/saasservicemgmt_v1.projects.locations.rollouts.html
+++ b/docs/dyn/saasservicemgmt_v1.projects.locations.rollouts.html
@@ -131,7 +131,7 @@ 

Method Details

"name": "A String", # Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/rollout/{rollout_id}" "parentRollout": "A String", # Optional. Output only. The direct parent rollout that this rollout is stemming from. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/rollouts/{rollout_id}" "release": "A String", # Optional. Immutable. Name of the Release that gets rolled out to target Units. Required if no other type of release is specified. - "rolloutKind": "A String", # Optional. Immutable. Name of the RolloutKind this rollout is stemming from and adhering to. + "rolloutKind": "A String", # Required. Immutable. Name of the RolloutKind this rollout is stemming from and adhering to. "rolloutOrchestrationStrategy": "A String", # Optional. The strategy used for executing this Rollout. This strategy will override whatever strategy is specified in the RolloutKind. If not specified on creation, the strategy from RolloutKind will be used. There are two supported values strategies which are used to control - "Google.Cloud.Simple.AllAtOnce" - "Google.Cloud.Simple.OneLocationAtATime" A rollout with one of these simple strategies will rollout across all locations defined in the targeted UnitKind's Saas Locations. "rootRollout": "A String", # Optional. Output only. The root rollout that this rollout is stemming from. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/rollouts/{rollout_id}" "startTime": "A String", # Optional. Output only. The time when the rollout started executing. Will be empty if the rollout hasn't started yet. @@ -184,7 +184,7 @@

Method Details

"name": "A String", # Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/rollout/{rollout_id}" "parentRollout": "A String", # Optional. Output only. The direct parent rollout that this rollout is stemming from. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/rollouts/{rollout_id}" "release": "A String", # Optional. Immutable. Name of the Release that gets rolled out to target Units. Required if no other type of release is specified. - "rolloutKind": "A String", # Optional. Immutable. Name of the RolloutKind this rollout is stemming from and adhering to. + "rolloutKind": "A String", # Required. Immutable. Name of the RolloutKind this rollout is stemming from and adhering to. "rolloutOrchestrationStrategy": "A String", # Optional. The strategy used for executing this Rollout. This strategy will override whatever strategy is specified in the RolloutKind. If not specified on creation, the strategy from RolloutKind will be used. There are two supported values strategies which are used to control - "Google.Cloud.Simple.AllAtOnce" - "Google.Cloud.Simple.OneLocationAtATime" A rollout with one of these simple strategies will rollout across all locations defined in the targeted UnitKind's Saas Locations. "rootRollout": "A String", # Optional. Output only. The root rollout that this rollout is stemming from. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/rollouts/{rollout_id}" "startTime": "A String", # Optional. Output only. The time when the rollout started executing. Will be empty if the rollout hasn't started yet. @@ -262,7 +262,7 @@

Method Details

"name": "A String", # Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/rollout/{rollout_id}" "parentRollout": "A String", # Optional. Output only. The direct parent rollout that this rollout is stemming from. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/rollouts/{rollout_id}" "release": "A String", # Optional. Immutable. Name of the Release that gets rolled out to target Units. Required if no other type of release is specified. - "rolloutKind": "A String", # Optional. Immutable. Name of the RolloutKind this rollout is stemming from and adhering to. + "rolloutKind": "A String", # Required. Immutable. Name of the RolloutKind this rollout is stemming from and adhering to. "rolloutOrchestrationStrategy": "A String", # Optional. The strategy used for executing this Rollout. This strategy will override whatever strategy is specified in the RolloutKind. If not specified on creation, the strategy from RolloutKind will be used. There are two supported values strategies which are used to control - "Google.Cloud.Simple.AllAtOnce" - "Google.Cloud.Simple.OneLocationAtATime" A rollout with one of these simple strategies will rollout across all locations defined in the targeted UnitKind's Saas Locations. "rootRollout": "A String", # Optional. Output only. The root rollout that this rollout is stemming from. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/rollouts/{rollout_id}" "startTime": "A String", # Optional. Output only. The time when the rollout started executing. Will be empty if the rollout hasn't started yet. @@ -326,7 +326,7 @@

Method Details

"name": "A String", # Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/rollout/{rollout_id}" "parentRollout": "A String", # Optional. Output only. The direct parent rollout that this rollout is stemming from. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/rollouts/{rollout_id}" "release": "A String", # Optional. Immutable. Name of the Release that gets rolled out to target Units. Required if no other type of release is specified. - "rolloutKind": "A String", # Optional. Immutable. Name of the RolloutKind this rollout is stemming from and adhering to. + "rolloutKind": "A String", # Required. Immutable. Name of the RolloutKind this rollout is stemming from and adhering to. "rolloutOrchestrationStrategy": "A String", # Optional. The strategy used for executing this Rollout. This strategy will override whatever strategy is specified in the RolloutKind. If not specified on creation, the strategy from RolloutKind will be used. There are two supported values strategies which are used to control - "Google.Cloud.Simple.AllAtOnce" - "Google.Cloud.Simple.OneLocationAtATime" A rollout with one of these simple strategies will rollout across all locations defined in the targeted UnitKind's Saas Locations. "rootRollout": "A String", # Optional. Output only. The root rollout that this rollout is stemming from. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/rollouts/{rollout_id}" "startTime": "A String", # Optional. Output only. The time when the rollout started executing. Will be empty if the rollout hasn't started yet. @@ -397,7 +397,7 @@

Method Details

"name": "A String", # Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/rollout/{rollout_id}" "parentRollout": "A String", # Optional. Output only. The direct parent rollout that this rollout is stemming from. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/rollouts/{rollout_id}" "release": "A String", # Optional. Immutable. Name of the Release that gets rolled out to target Units. Required if no other type of release is specified. - "rolloutKind": "A String", # Optional. Immutable. Name of the RolloutKind this rollout is stemming from and adhering to. + "rolloutKind": "A String", # Required. Immutable. Name of the RolloutKind this rollout is stemming from and adhering to. "rolloutOrchestrationStrategy": "A String", # Optional. The strategy used for executing this Rollout. This strategy will override whatever strategy is specified in the RolloutKind. If not specified on creation, the strategy from RolloutKind will be used. There are two supported values strategies which are used to control - "Google.Cloud.Simple.AllAtOnce" - "Google.Cloud.Simple.OneLocationAtATime" A rollout with one of these simple strategies will rollout across all locations defined in the targeted UnitKind's Saas Locations. "rootRollout": "A String", # Optional. Output only. The root rollout that this rollout is stemming from. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/rollouts/{rollout_id}" "startTime": "A String", # Optional. Output only. The time when the rollout started executing. Will be empty if the rollout hasn't started yet. @@ -450,7 +450,7 @@

Method Details

"name": "A String", # Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/rollout/{rollout_id}" "parentRollout": "A String", # Optional. Output only. The direct parent rollout that this rollout is stemming from. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/rollouts/{rollout_id}" "release": "A String", # Optional. Immutable. Name of the Release that gets rolled out to target Units. Required if no other type of release is specified. - "rolloutKind": "A String", # Optional. Immutable. Name of the RolloutKind this rollout is stemming from and adhering to. + "rolloutKind": "A String", # Required. Immutable. Name of the RolloutKind this rollout is stemming from and adhering to. "rolloutOrchestrationStrategy": "A String", # Optional. The strategy used for executing this Rollout. This strategy will override whatever strategy is specified in the RolloutKind. If not specified on creation, the strategy from RolloutKind will be used. There are two supported values strategies which are used to control - "Google.Cloud.Simple.AllAtOnce" - "Google.Cloud.Simple.OneLocationAtATime" A rollout with one of these simple strategies will rollout across all locations defined in the targeted UnitKind's Saas Locations. "rootRollout": "A String", # Optional. Output only. The root rollout that this rollout is stemming from. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/rollouts/{rollout_id}" "startTime": "A String", # Optional. Output only. The time when the rollout started executing. Will be empty if the rollout hasn't started yet. diff --git a/docs/dyn/saasservicemgmt_v1.projects.locations.saas.html b/docs/dyn/saasservicemgmt_v1.projects.locations.saas.html index f61e9b4d5f..f04c730a93 100644 --- a/docs/dyn/saasservicemgmt_v1.projects.locations.saas.html +++ b/docs/dyn/saasservicemgmt_v1.projects.locations.saas.html @@ -114,7 +114,25 @@

Method Details

"annotations": { # Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations "a_key": "A String", }, + "conditions": [ # Output only. A set of conditions which indicate the various conditions this resource can have. + { # SaasCondition describes the status of a Saas. + "lastTransitionTime": "A String", # Required. Last time the condition transited from one status to another. + "message": "A String", # Required. Human readable message indicating details about the last transition. + "reason": "A String", # Required. Brief reason for the condition's last transition. + "status": "A String", # Required. Status of the condition. + "type": "A String", # Required. Type of the condition. + }, + ], "createTime": "A String", # Output only. The timestamp when the resource was created. + "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). # Output only. If the state is FAILED, the corresponding error code and message. Defaults to code=OK for all other states. + "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. + }, "etag": "A String", # Output only. An opaque value that uniquely identifies a version or generation of a resource. It can be used to confirm that the client and server agree on the ordering of a resource being written. "labels": { # Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels. "a_key": "A String", @@ -125,6 +143,7 @@

Method Details

}, ], "name": "A String", # Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/saas/{saas}" + "state": "A String", # Output only. State of the Saas. It is always in ACTIVE state if the application_template is empty. "uid": "A String", # Output only. The unique identifier of the resource. UID is unique in the time and space for this resource within the scope of the service. It is typically generated by the server on successful creation of a resource and must not be changed. UID is used to uniquely identify resources with resource name reuses. This should be a UUID4. "updateTime": "A String", # Output only. The timestamp when the resource was last updated. Any change to the resource made by users must refresh this value. Changes to a resource made by the service should refresh this value. } @@ -144,7 +163,25 @@

Method Details

"annotations": { # Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations "a_key": "A String", }, + "conditions": [ # Output only. A set of conditions which indicate the various conditions this resource can have. + { # SaasCondition describes the status of a Saas. + "lastTransitionTime": "A String", # Required. Last time the condition transited from one status to another. + "message": "A String", # Required. Human readable message indicating details about the last transition. + "reason": "A String", # Required. Brief reason for the condition's last transition. + "status": "A String", # Required. Status of the condition. + "type": "A String", # Required. Type of the condition. + }, + ], "createTime": "A String", # Output only. The timestamp when the resource was created. + "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). # Output only. If the state is FAILED, the corresponding error code and message. Defaults to code=OK for all other states. + "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. + }, "etag": "A String", # Output only. An opaque value that uniquely identifies a version or generation of a resource. It can be used to confirm that the client and server agree on the ordering of a resource being written. "labels": { # Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels. "a_key": "A String", @@ -155,6 +192,7 @@

Method Details

}, ], "name": "A String", # Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/saas/{saas}" + "state": "A String", # Output only. State of the Saas. It is always in ACTIVE state if the application_template is empty. "uid": "A String", # Output only. The unique identifier of the resource. UID is unique in the time and space for this resource within the scope of the service. It is typically generated by the server on successful creation of a resource and must not be changed. UID is used to uniquely identify resources with resource name reuses. This should be a UUID4. "updateTime": "A String", # Output only. The timestamp when the resource was last updated. Any change to the resource made by users must refresh this value. Changes to a resource made by the service should refresh this value. }
@@ -199,7 +237,25 @@

Method Details

"annotations": { # Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations "a_key": "A String", }, + "conditions": [ # Output only. A set of conditions which indicate the various conditions this resource can have. + { # SaasCondition describes the status of a Saas. + "lastTransitionTime": "A String", # Required. Last time the condition transited from one status to another. + "message": "A String", # Required. Human readable message indicating details about the last transition. + "reason": "A String", # Required. Brief reason for the condition's last transition. + "status": "A String", # Required. Status of the condition. + "type": "A String", # Required. Type of the condition. + }, + ], "createTime": "A String", # Output only. The timestamp when the resource was created. + "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). # Output only. If the state is FAILED, the corresponding error code and message. Defaults to code=OK for all other states. + "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. + }, "etag": "A String", # Output only. An opaque value that uniquely identifies a version or generation of a resource. It can be used to confirm that the client and server agree on the ordering of a resource being written. "labels": { # Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels. "a_key": "A String", @@ -210,6 +266,7 @@

Method Details

}, ], "name": "A String", # Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/saas/{saas}" + "state": "A String", # Output only. State of the Saas. It is always in ACTIVE state if the application_template is empty. "uid": "A String", # Output only. The unique identifier of the resource. UID is unique in the time and space for this resource within the scope of the service. It is typically generated by the server on successful creation of a resource and must not be changed. UID is used to uniquely identify resources with resource name reuses. This should be a UUID4. "updateTime": "A String", # Output only. The timestamp when the resource was last updated. Any change to the resource made by users must refresh this value. Changes to a resource made by the service should refresh this value. }
@@ -240,7 +297,25 @@

Method Details

"annotations": { # Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations "a_key": "A String", }, + "conditions": [ # Output only. A set of conditions which indicate the various conditions this resource can have. + { # SaasCondition describes the status of a Saas. + "lastTransitionTime": "A String", # Required. Last time the condition transited from one status to another. + "message": "A String", # Required. Human readable message indicating details about the last transition. + "reason": "A String", # Required. Brief reason for the condition's last transition. + "status": "A String", # Required. Status of the condition. + "type": "A String", # Required. Type of the condition. + }, + ], "createTime": "A String", # Output only. The timestamp when the resource was created. + "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). # Output only. If the state is FAILED, the corresponding error code and message. Defaults to code=OK for all other states. + "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. + }, "etag": "A String", # Output only. An opaque value that uniquely identifies a version or generation of a resource. It can be used to confirm that the client and server agree on the ordering of a resource being written. "labels": { # Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels. "a_key": "A String", @@ -251,6 +326,7 @@

Method Details

}, ], "name": "A String", # Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/saas/{saas}" + "state": "A String", # Output only. State of the Saas. It is always in ACTIVE state if the application_template is empty. "uid": "A String", # Output only. The unique identifier of the resource. UID is unique in the time and space for this resource within the scope of the service. It is typically generated by the server on successful creation of a resource and must not be changed. UID is used to uniquely identify resources with resource name reuses. This should be a UUID4. "updateTime": "A String", # Output only. The timestamp when the resource was last updated. Any change to the resource made by users must refresh this value. Changes to a resource made by the service should refresh this value. }, @@ -288,7 +364,25 @@

Method Details

"annotations": { # Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations "a_key": "A String", }, + "conditions": [ # Output only. A set of conditions which indicate the various conditions this resource can have. + { # SaasCondition describes the status of a Saas. + "lastTransitionTime": "A String", # Required. Last time the condition transited from one status to another. + "message": "A String", # Required. Human readable message indicating details about the last transition. + "reason": "A String", # Required. Brief reason for the condition's last transition. + "status": "A String", # Required. Status of the condition. + "type": "A String", # Required. Type of the condition. + }, + ], "createTime": "A String", # Output only. The timestamp when the resource was created. + "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). # Output only. If the state is FAILED, the corresponding error code and message. Defaults to code=OK for all other states. + "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. + }, "etag": "A String", # Output only. An opaque value that uniquely identifies a version or generation of a resource. It can be used to confirm that the client and server agree on the ordering of a resource being written. "labels": { # Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels. "a_key": "A String", @@ -299,6 +393,7 @@

Method Details

}, ], "name": "A String", # Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/saas/{saas}" + "state": "A String", # Output only. State of the Saas. It is always in ACTIVE state if the application_template is empty. "uid": "A String", # Output only. The unique identifier of the resource. UID is unique in the time and space for this resource within the scope of the service. It is typically generated by the server on successful creation of a resource and must not be changed. UID is used to uniquely identify resources with resource name reuses. This should be a UUID4. "updateTime": "A String", # Output only. The timestamp when the resource was last updated. Any change to the resource made by users must refresh this value. Changes to a resource made by the service should refresh this value. } @@ -318,7 +413,25 @@

Method Details

"annotations": { # Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations "a_key": "A String", }, + "conditions": [ # Output only. A set of conditions which indicate the various conditions this resource can have. + { # SaasCondition describes the status of a Saas. + "lastTransitionTime": "A String", # Required. Last time the condition transited from one status to another. + "message": "A String", # Required. Human readable message indicating details about the last transition. + "reason": "A String", # Required. Brief reason for the condition's last transition. + "status": "A String", # Required. Status of the condition. + "type": "A String", # Required. Type of the condition. + }, + ], "createTime": "A String", # Output only. The timestamp when the resource was created. + "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). # Output only. If the state is FAILED, the corresponding error code and message. Defaults to code=OK for all other states. + "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. + }, "etag": "A String", # Output only. An opaque value that uniquely identifies a version or generation of a resource. It can be used to confirm that the client and server agree on the ordering of a resource being written. "labels": { # Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels. "a_key": "A String", @@ -329,6 +442,7 @@

Method Details

}, ], "name": "A String", # Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/saas/{saas}" + "state": "A String", # Output only. State of the Saas. It is always in ACTIVE state if the application_template is empty. "uid": "A String", # Output only. The unique identifier of the resource. UID is unique in the time and space for this resource within the scope of the service. It is typically generated by the server on successful creation of a resource and must not be changed. UID is used to uniquely identify resources with resource name reuses. This should be a UUID4. "updateTime": "A String", # Output only. The timestamp when the resource was last updated. Any change to the resource made by users must refresh this value. Changes to a resource made by the service should refresh this value. }
diff --git a/docs/dyn/saasservicemgmt_v1beta1.projects.locations.html b/docs/dyn/saasservicemgmt_v1beta1.projects.locations.html index 17c6f91edd..2b3cd501d9 100644 --- a/docs/dyn/saasservicemgmt_v1beta1.projects.locations.html +++ b/docs/dyn/saasservicemgmt_v1beta1.projects.locations.html @@ -122,7 +122,7 @@

Instance Methods

Gets information about a location.

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

-

Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.

+

Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.

list_next()

Retrieves the next page of results.

@@ -161,7 +161,7 @@

Method Details

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
+  
Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
diff --git a/docs/dyn/saasservicemgmt_v1beta1.projects.locations.releases.html b/docs/dyn/saasservicemgmt_v1beta1.projects.locations.releases.html
index 9bc0eba286..602a8a369b 100644
--- a/docs/dyn/saasservicemgmt_v1beta1.projects.locations.releases.html
+++ b/docs/dyn/saasservicemgmt_v1beta1.projects.locations.releases.html
@@ -114,6 +114,15 @@ 

Method Details

"annotations": { # Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations "a_key": "A String", }, + "applicationTemplateComponent": { # ComponentRef represents a reference to a component resource. Next ID: 4 # Output only. Reference to component and revision in a composite ApplicationTemplate. + "component": "A String", # Name of the component in composite.Components + "compositeRef": { # CompositeRef represents a reference to a composite resource. Next ID: 4 # Reference to the Composite ApplicationTemplate. + "applicationTemplate": "A String", # Required. Reference to the ApplicationTemplate resource. + "revision": "A String", # Revision of the ApplicationTemplate to use. Changes to revision will trigger manual resynchronization. If empty, ApplicationTemplate will be ignored. + "syncOperation": "A String", # Output only. Reference to on-going AppTemplate import and replication operation (i.e. the operation_id for the long-running operation). This field is opaque for external usage. + }, + "revision": "A String", # Revision of the component. If the component does not have a revision, this field will be explicitly set to the revision of the composite ApplicationTemplate. + }, "blueprint": { # Blueprints are OCI Images that contain all of the artifacts needed to provision a unit. Metadata such as, type of the engine used to actuate the blueprint (e.g. terraform, helm etc) and version will come from the image manifest. If the hostname is omitted, it will be assumed to be the regional path to Artifact Registry (eg. us-east1-docker.pkg.dev). # Optional. Blueprints are OCI Images that contain all of the artifacts needed to provision a unit. "engine": "A String", # Output only. Type of the engine used to actuate the blueprint. e.g. terraform, helm etc. "package": "A String", # Optional. Immutable. URI to a blueprint used by the Unit (required unless unitKind or release is set). @@ -171,6 +180,15 @@

Method Details

"annotations": { # Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations "a_key": "A String", }, + "applicationTemplateComponent": { # ComponentRef represents a reference to a component resource. Next ID: 4 # Output only. Reference to component and revision in a composite ApplicationTemplate. + "component": "A String", # Name of the component in composite.Components + "compositeRef": { # CompositeRef represents a reference to a composite resource. Next ID: 4 # Reference to the Composite ApplicationTemplate. + "applicationTemplate": "A String", # Required. Reference to the ApplicationTemplate resource. + "revision": "A String", # Revision of the ApplicationTemplate to use. Changes to revision will trigger manual resynchronization. If empty, ApplicationTemplate will be ignored. + "syncOperation": "A String", # Output only. Reference to on-going AppTemplate import and replication operation (i.e. the operation_id for the long-running operation). This field is opaque for external usage. + }, + "revision": "A String", # Revision of the component. If the component does not have a revision, this field will be explicitly set to the revision of the composite ApplicationTemplate. + }, "blueprint": { # Blueprints are OCI Images that contain all of the artifacts needed to provision a unit. Metadata such as, type of the engine used to actuate the blueprint (e.g. terraform, helm etc) and version will come from the image manifest. If the hostname is omitted, it will be assumed to be the regional path to Artifact Registry (eg. us-east1-docker.pkg.dev). # Optional. Blueprints are OCI Images that contain all of the artifacts needed to provision a unit. "engine": "A String", # Output only. Type of the engine used to actuate the blueprint. e.g. terraform, helm etc. "package": "A String", # Optional. Immutable. URI to a blueprint used by the Unit (required unless unitKind or release is set). @@ -253,6 +271,15 @@

Method Details

"annotations": { # Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations "a_key": "A String", }, + "applicationTemplateComponent": { # ComponentRef represents a reference to a component resource. Next ID: 4 # Output only. Reference to component and revision in a composite ApplicationTemplate. + "component": "A String", # Name of the component in composite.Components + "compositeRef": { # CompositeRef represents a reference to a composite resource. Next ID: 4 # Reference to the Composite ApplicationTemplate. + "applicationTemplate": "A String", # Required. Reference to the ApplicationTemplate resource. + "revision": "A String", # Revision of the ApplicationTemplate to use. Changes to revision will trigger manual resynchronization. If empty, ApplicationTemplate will be ignored. + "syncOperation": "A String", # Output only. Reference to on-going AppTemplate import and replication operation (i.e. the operation_id for the long-running operation). This field is opaque for external usage. + }, + "revision": "A String", # Revision of the component. If the component does not have a revision, this field will be explicitly set to the revision of the composite ApplicationTemplate. + }, "blueprint": { # Blueprints are OCI Images that contain all of the artifacts needed to provision a unit. Metadata such as, type of the engine used to actuate the blueprint (e.g. terraform, helm etc) and version will come from the image manifest. If the hostname is omitted, it will be assumed to be the regional path to Artifact Registry (eg. us-east1-docker.pkg.dev). # Optional. Blueprints are OCI Images that contain all of the artifacts needed to provision a unit. "engine": "A String", # Output only. Type of the engine used to actuate the blueprint. e.g. terraform, helm etc. "package": "A String", # Optional. Immutable. URI to a blueprint used by the Unit (required unless unitKind or release is set). @@ -321,6 +348,15 @@

Method Details

"annotations": { # Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations "a_key": "A String", }, + "applicationTemplateComponent": { # ComponentRef represents a reference to a component resource. Next ID: 4 # Output only. Reference to component and revision in a composite ApplicationTemplate. + "component": "A String", # Name of the component in composite.Components + "compositeRef": { # CompositeRef represents a reference to a composite resource. Next ID: 4 # Reference to the Composite ApplicationTemplate. + "applicationTemplate": "A String", # Required. Reference to the ApplicationTemplate resource. + "revision": "A String", # Revision of the ApplicationTemplate to use. Changes to revision will trigger manual resynchronization. If empty, ApplicationTemplate will be ignored. + "syncOperation": "A String", # Output only. Reference to on-going AppTemplate import and replication operation (i.e. the operation_id for the long-running operation). This field is opaque for external usage. + }, + "revision": "A String", # Revision of the component. If the component does not have a revision, this field will be explicitly set to the revision of the composite ApplicationTemplate. + }, "blueprint": { # Blueprints are OCI Images that contain all of the artifacts needed to provision a unit. Metadata such as, type of the engine used to actuate the blueprint (e.g. terraform, helm etc) and version will come from the image manifest. If the hostname is omitted, it will be assumed to be the regional path to Artifact Registry (eg. us-east1-docker.pkg.dev). # Optional. Blueprints are OCI Images that contain all of the artifacts needed to provision a unit. "engine": "A String", # Output only. Type of the engine used to actuate the blueprint. e.g. terraform, helm etc. "package": "A String", # Optional. Immutable. URI to a blueprint used by the Unit (required unless unitKind or release is set). @@ -396,6 +432,15 @@

Method Details

"annotations": { # Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations "a_key": "A String", }, + "applicationTemplateComponent": { # ComponentRef represents a reference to a component resource. Next ID: 4 # Output only. Reference to component and revision in a composite ApplicationTemplate. + "component": "A String", # Name of the component in composite.Components + "compositeRef": { # CompositeRef represents a reference to a composite resource. Next ID: 4 # Reference to the Composite ApplicationTemplate. + "applicationTemplate": "A String", # Required. Reference to the ApplicationTemplate resource. + "revision": "A String", # Revision of the ApplicationTemplate to use. Changes to revision will trigger manual resynchronization. If empty, ApplicationTemplate will be ignored. + "syncOperation": "A String", # Output only. Reference to on-going AppTemplate import and replication operation (i.e. the operation_id for the long-running operation). This field is opaque for external usage. + }, + "revision": "A String", # Revision of the component. If the component does not have a revision, this field will be explicitly set to the revision of the composite ApplicationTemplate. + }, "blueprint": { # Blueprints are OCI Images that contain all of the artifacts needed to provision a unit. Metadata such as, type of the engine used to actuate the blueprint (e.g. terraform, helm etc) and version will come from the image manifest. If the hostname is omitted, it will be assumed to be the regional path to Artifact Registry (eg. us-east1-docker.pkg.dev). # Optional. Blueprints are OCI Images that contain all of the artifacts needed to provision a unit. "engine": "A String", # Output only. Type of the engine used to actuate the blueprint. e.g. terraform, helm etc. "package": "A String", # Optional. Immutable. URI to a blueprint used by the Unit (required unless unitKind or release is set). @@ -453,6 +498,15 @@

Method Details

"annotations": { # Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations "a_key": "A String", }, + "applicationTemplateComponent": { # ComponentRef represents a reference to a component resource. Next ID: 4 # Output only. Reference to component and revision in a composite ApplicationTemplate. + "component": "A String", # Name of the component in composite.Components + "compositeRef": { # CompositeRef represents a reference to a composite resource. Next ID: 4 # Reference to the Composite ApplicationTemplate. + "applicationTemplate": "A String", # Required. Reference to the ApplicationTemplate resource. + "revision": "A String", # Revision of the ApplicationTemplate to use. Changes to revision will trigger manual resynchronization. If empty, ApplicationTemplate will be ignored. + "syncOperation": "A String", # Output only. Reference to on-going AppTemplate import and replication operation (i.e. the operation_id for the long-running operation). This field is opaque for external usage. + }, + "revision": "A String", # Revision of the component. If the component does not have a revision, this field will be explicitly set to the revision of the composite ApplicationTemplate. + }, "blueprint": { # Blueprints are OCI Images that contain all of the artifacts needed to provision a unit. Metadata such as, type of the engine used to actuate the blueprint (e.g. terraform, helm etc) and version will come from the image manifest. If the hostname is omitted, it will be assumed to be the regional path to Artifact Registry (eg. us-east1-docker.pkg.dev). # Optional. Blueprints are OCI Images that contain all of the artifacts needed to provision a unit. "engine": "A String", # Output only. Type of the engine used to actuate the blueprint. e.g. terraform, helm etc. "package": "A String", # Optional. Immutable. URI to a blueprint used by the Unit (required unless unitKind or release is set). diff --git a/docs/dyn/saasservicemgmt_v1beta1.projects.locations.rollouts.html b/docs/dyn/saasservicemgmt_v1beta1.projects.locations.rollouts.html index f21c0d06e4..a81c69984d 100644 --- a/docs/dyn/saasservicemgmt_v1beta1.projects.locations.rollouts.html +++ b/docs/dyn/saasservicemgmt_v1beta1.projects.locations.rollouts.html @@ -131,7 +131,7 @@

Method Details

"name": "A String", # Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/rollout/{rollout_id}" "parentRollout": "A String", # Optional. Output only. The direct parent rollout that this rollout is stemming from. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/rollouts/{rollout_id}" "release": "A String", # Optional. Immutable. Name of the Release that gets rolled out to target Units. Required if no other type of release is specified. - "rolloutKind": "A String", # Optional. Immutable. Name of the RolloutKind this rollout is stemming from and adhering to. + "rolloutKind": "A String", # Required. Immutable. Name of the RolloutKind this rollout is stemming from and adhering to. "rolloutOrchestrationStrategy": "A String", # Optional. The strategy used for executing this Rollout. This strategy will override whatever strategy is specified in the RolloutKind. If not specified on creation, the strategy from RolloutKind will be used. There are two supported values strategies which are used to control - "Google.Cloud.Simple.AllAtOnce" - "Google.Cloud.Simple.OneLocationAtATime" A rollout with one of these simple strategies will rollout across all locations defined in the targeted UnitKind's Saas Locations. "rootRollout": "A String", # Optional. Output only. The root rollout that this rollout is stemming from. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/rollouts/{rollout_id}" "startTime": "A String", # Optional. Output only. The time when the rollout started executing. Will be empty if the rollout hasn't started yet. @@ -184,7 +184,7 @@

Method Details

"name": "A String", # Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/rollout/{rollout_id}" "parentRollout": "A String", # Optional. Output only. The direct parent rollout that this rollout is stemming from. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/rollouts/{rollout_id}" "release": "A String", # Optional. Immutable. Name of the Release that gets rolled out to target Units. Required if no other type of release is specified. - "rolloutKind": "A String", # Optional. Immutable. Name of the RolloutKind this rollout is stemming from and adhering to. + "rolloutKind": "A String", # Required. Immutable. Name of the RolloutKind this rollout is stemming from and adhering to. "rolloutOrchestrationStrategy": "A String", # Optional. The strategy used for executing this Rollout. This strategy will override whatever strategy is specified in the RolloutKind. If not specified on creation, the strategy from RolloutKind will be used. There are two supported values strategies which are used to control - "Google.Cloud.Simple.AllAtOnce" - "Google.Cloud.Simple.OneLocationAtATime" A rollout with one of these simple strategies will rollout across all locations defined in the targeted UnitKind's Saas Locations. "rootRollout": "A String", # Optional. Output only. The root rollout that this rollout is stemming from. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/rollouts/{rollout_id}" "startTime": "A String", # Optional. Output only. The time when the rollout started executing. Will be empty if the rollout hasn't started yet. @@ -262,7 +262,7 @@

Method Details

"name": "A String", # Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/rollout/{rollout_id}" "parentRollout": "A String", # Optional. Output only. The direct parent rollout that this rollout is stemming from. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/rollouts/{rollout_id}" "release": "A String", # Optional. Immutable. Name of the Release that gets rolled out to target Units. Required if no other type of release is specified. - "rolloutKind": "A String", # Optional. Immutable. Name of the RolloutKind this rollout is stemming from and adhering to. + "rolloutKind": "A String", # Required. Immutable. Name of the RolloutKind this rollout is stemming from and adhering to. "rolloutOrchestrationStrategy": "A String", # Optional. The strategy used for executing this Rollout. This strategy will override whatever strategy is specified in the RolloutKind. If not specified on creation, the strategy from RolloutKind will be used. There are two supported values strategies which are used to control - "Google.Cloud.Simple.AllAtOnce" - "Google.Cloud.Simple.OneLocationAtATime" A rollout with one of these simple strategies will rollout across all locations defined in the targeted UnitKind's Saas Locations. "rootRollout": "A String", # Optional. Output only. The root rollout that this rollout is stemming from. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/rollouts/{rollout_id}" "startTime": "A String", # Optional. Output only. The time when the rollout started executing. Will be empty if the rollout hasn't started yet. @@ -326,7 +326,7 @@

Method Details

"name": "A String", # Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/rollout/{rollout_id}" "parentRollout": "A String", # Optional. Output only. The direct parent rollout that this rollout is stemming from. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/rollouts/{rollout_id}" "release": "A String", # Optional. Immutable. Name of the Release that gets rolled out to target Units. Required if no other type of release is specified. - "rolloutKind": "A String", # Optional. Immutable. Name of the RolloutKind this rollout is stemming from and adhering to. + "rolloutKind": "A String", # Required. Immutable. Name of the RolloutKind this rollout is stemming from and adhering to. "rolloutOrchestrationStrategy": "A String", # Optional. The strategy used for executing this Rollout. This strategy will override whatever strategy is specified in the RolloutKind. If not specified on creation, the strategy from RolloutKind will be used. There are two supported values strategies which are used to control - "Google.Cloud.Simple.AllAtOnce" - "Google.Cloud.Simple.OneLocationAtATime" A rollout with one of these simple strategies will rollout across all locations defined in the targeted UnitKind's Saas Locations. "rootRollout": "A String", # Optional. Output only. The root rollout that this rollout is stemming from. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/rollouts/{rollout_id}" "startTime": "A String", # Optional. Output only. The time when the rollout started executing. Will be empty if the rollout hasn't started yet. @@ -397,7 +397,7 @@

Method Details

"name": "A String", # Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/rollout/{rollout_id}" "parentRollout": "A String", # Optional. Output only. The direct parent rollout that this rollout is stemming from. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/rollouts/{rollout_id}" "release": "A String", # Optional. Immutable. Name of the Release that gets rolled out to target Units. Required if no other type of release is specified. - "rolloutKind": "A String", # Optional. Immutable. Name of the RolloutKind this rollout is stemming from and adhering to. + "rolloutKind": "A String", # Required. Immutable. Name of the RolloutKind this rollout is stemming from and adhering to. "rolloutOrchestrationStrategy": "A String", # Optional. The strategy used for executing this Rollout. This strategy will override whatever strategy is specified in the RolloutKind. If not specified on creation, the strategy from RolloutKind will be used. There are two supported values strategies which are used to control - "Google.Cloud.Simple.AllAtOnce" - "Google.Cloud.Simple.OneLocationAtATime" A rollout with one of these simple strategies will rollout across all locations defined in the targeted UnitKind's Saas Locations. "rootRollout": "A String", # Optional. Output only. The root rollout that this rollout is stemming from. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/rollouts/{rollout_id}" "startTime": "A String", # Optional. Output only. The time when the rollout started executing. Will be empty if the rollout hasn't started yet. @@ -450,7 +450,7 @@

Method Details

"name": "A String", # Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/rollout/{rollout_id}" "parentRollout": "A String", # Optional. Output only. The direct parent rollout that this rollout is stemming from. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/rollouts/{rollout_id}" "release": "A String", # Optional. Immutable. Name of the Release that gets rolled out to target Units. Required if no other type of release is specified. - "rolloutKind": "A String", # Optional. Immutable. Name of the RolloutKind this rollout is stemming from and adhering to. + "rolloutKind": "A String", # Required. Immutable. Name of the RolloutKind this rollout is stemming from and adhering to. "rolloutOrchestrationStrategy": "A String", # Optional. The strategy used for executing this Rollout. This strategy will override whatever strategy is specified in the RolloutKind. If not specified on creation, the strategy from RolloutKind will be used. There are two supported values strategies which are used to control - "Google.Cloud.Simple.AllAtOnce" - "Google.Cloud.Simple.OneLocationAtATime" A rollout with one of these simple strategies will rollout across all locations defined in the targeted UnitKind's Saas Locations. "rootRollout": "A String", # Optional. Output only. The root rollout that this rollout is stemming from. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/rollouts/{rollout_id}" "startTime": "A String", # Optional. Output only. The time when the rollout started executing. Will be empty if the rollout hasn't started yet. diff --git a/docs/dyn/saasservicemgmt_v1beta1.projects.locations.saas.html b/docs/dyn/saasservicemgmt_v1beta1.projects.locations.saas.html index 1b54264aba..b9539a4bc9 100644 --- a/docs/dyn/saasservicemgmt_v1beta1.projects.locations.saas.html +++ b/docs/dyn/saasservicemgmt_v1beta1.projects.locations.saas.html @@ -114,7 +114,31 @@

Method Details

"annotations": { # Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations "a_key": "A String", }, + "applicationTemplate": { # CompositeRef represents a reference to a composite resource. Next ID: 4 # Reference to composite ApplicationTemplate. When specified, the template components will be imported into their equivalent UnitKind, Release and Blueprint resources. Deleted references will not delete imported resources. Should only be specified on source regions, and be unspecified on replica regions. + "applicationTemplate": "A String", # Required. Reference to the ApplicationTemplate resource. + "revision": "A String", # Revision of the ApplicationTemplate to use. Changes to revision will trigger manual resynchronization. If empty, ApplicationTemplate will be ignored. + "syncOperation": "A String", # Output only. Reference to on-going AppTemplate import and replication operation (i.e. the operation_id for the long-running operation). This field is opaque for external usage. + }, + "blueprintRepo": "A String", # Output only. Name of repository in Artifact Registry for system-generated Blueprints, eg. Blueprints of imported ApplicationTemplates. + "conditions": [ # Output only. A set of conditions which indicate the various conditions this resource can have. + { # SaasCondition describes the status of a Saas. + "lastTransitionTime": "A String", # Required. Last time the condition transited from one status to another. + "message": "A String", # Required. Human readable message indicating details about the last transition. + "reason": "A String", # Required. Brief reason for the condition's last transition. + "status": "A String", # Required. Status of the condition. + "type": "A String", # Required. Type of the condition. + }, + ], "createTime": "A String", # Output only. The timestamp when the resource was created. + "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). # Output only. If the state is FAILED, the corresponding error code and message. Defaults to code=OK for all other states. + "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. + }, "etag": "A String", # Output only. An opaque value that uniquely identifies a version or generation of a resource. It can be used to confirm that the client and server agree on the ordering of a resource being written. "labels": { # Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels. "a_key": "A String", @@ -125,6 +149,7 @@

Method Details

}, ], "name": "A String", # Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/saas/{saas}" + "state": "A String", # Output only. State of the Saas. It is always in ACTIVE state if the application_template is empty. "uid": "A String", # Output only. The unique identifier of the resource. UID is unique in the time and space for this resource within the scope of the service. It is typically generated by the server on successful creation of a resource and must not be changed. UID is used to uniquely identify resources with resource name reuses. This should be a UUID4. "updateTime": "A String", # Output only. The timestamp when the resource was last updated. Any change to the resource made by users must refresh this value. Changes to a resource made by the service should refresh this value. } @@ -144,7 +169,31 @@

Method Details

"annotations": { # Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations "a_key": "A String", }, + "applicationTemplate": { # CompositeRef represents a reference to a composite resource. Next ID: 4 # Reference to composite ApplicationTemplate. When specified, the template components will be imported into their equivalent UnitKind, Release and Blueprint resources. Deleted references will not delete imported resources. Should only be specified on source regions, and be unspecified on replica regions. + "applicationTemplate": "A String", # Required. Reference to the ApplicationTemplate resource. + "revision": "A String", # Revision of the ApplicationTemplate to use. Changes to revision will trigger manual resynchronization. If empty, ApplicationTemplate will be ignored. + "syncOperation": "A String", # Output only. Reference to on-going AppTemplate import and replication operation (i.e. the operation_id for the long-running operation). This field is opaque for external usage. + }, + "blueprintRepo": "A String", # Output only. Name of repository in Artifact Registry for system-generated Blueprints, eg. Blueprints of imported ApplicationTemplates. + "conditions": [ # Output only. A set of conditions which indicate the various conditions this resource can have. + { # SaasCondition describes the status of a Saas. + "lastTransitionTime": "A String", # Required. Last time the condition transited from one status to another. + "message": "A String", # Required. Human readable message indicating details about the last transition. + "reason": "A String", # Required. Brief reason for the condition's last transition. + "status": "A String", # Required. Status of the condition. + "type": "A String", # Required. Type of the condition. + }, + ], "createTime": "A String", # Output only. The timestamp when the resource was created. + "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). # Output only. If the state is FAILED, the corresponding error code and message. Defaults to code=OK for all other states. + "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. + }, "etag": "A String", # Output only. An opaque value that uniquely identifies a version or generation of a resource. It can be used to confirm that the client and server agree on the ordering of a resource being written. "labels": { # Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels. "a_key": "A String", @@ -155,6 +204,7 @@

Method Details

}, ], "name": "A String", # Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/saas/{saas}" + "state": "A String", # Output only. State of the Saas. It is always in ACTIVE state if the application_template is empty. "uid": "A String", # Output only. The unique identifier of the resource. UID is unique in the time and space for this resource within the scope of the service. It is typically generated by the server on successful creation of a resource and must not be changed. UID is used to uniquely identify resources with resource name reuses. This should be a UUID4. "updateTime": "A String", # Output only. The timestamp when the resource was last updated. Any change to the resource made by users must refresh this value. Changes to a resource made by the service should refresh this value. }
@@ -199,7 +249,31 @@

Method Details

"annotations": { # Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations "a_key": "A String", }, + "applicationTemplate": { # CompositeRef represents a reference to a composite resource. Next ID: 4 # Reference to composite ApplicationTemplate. When specified, the template components will be imported into their equivalent UnitKind, Release and Blueprint resources. Deleted references will not delete imported resources. Should only be specified on source regions, and be unspecified on replica regions. + "applicationTemplate": "A String", # Required. Reference to the ApplicationTemplate resource. + "revision": "A String", # Revision of the ApplicationTemplate to use. Changes to revision will trigger manual resynchronization. If empty, ApplicationTemplate will be ignored. + "syncOperation": "A String", # Output only. Reference to on-going AppTemplate import and replication operation (i.e. the operation_id for the long-running operation). This field is opaque for external usage. + }, + "blueprintRepo": "A String", # Output only. Name of repository in Artifact Registry for system-generated Blueprints, eg. Blueprints of imported ApplicationTemplates. + "conditions": [ # Output only. A set of conditions which indicate the various conditions this resource can have. + { # SaasCondition describes the status of a Saas. + "lastTransitionTime": "A String", # Required. Last time the condition transited from one status to another. + "message": "A String", # Required. Human readable message indicating details about the last transition. + "reason": "A String", # Required. Brief reason for the condition's last transition. + "status": "A String", # Required. Status of the condition. + "type": "A String", # Required. Type of the condition. + }, + ], "createTime": "A String", # Output only. The timestamp when the resource was created. + "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). # Output only. If the state is FAILED, the corresponding error code and message. Defaults to code=OK for all other states. + "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. + }, "etag": "A String", # Output only. An opaque value that uniquely identifies a version or generation of a resource. It can be used to confirm that the client and server agree on the ordering of a resource being written. "labels": { # Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels. "a_key": "A String", @@ -210,6 +284,7 @@

Method Details

}, ], "name": "A String", # Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/saas/{saas}" + "state": "A String", # Output only. State of the Saas. It is always in ACTIVE state if the application_template is empty. "uid": "A String", # Output only. The unique identifier of the resource. UID is unique in the time and space for this resource within the scope of the service. It is typically generated by the server on successful creation of a resource and must not be changed. UID is used to uniquely identify resources with resource name reuses. This should be a UUID4. "updateTime": "A String", # Output only. The timestamp when the resource was last updated. Any change to the resource made by users must refresh this value. Changes to a resource made by the service should refresh this value. }
@@ -240,7 +315,31 @@

Method Details

"annotations": { # Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations "a_key": "A String", }, + "applicationTemplate": { # CompositeRef represents a reference to a composite resource. Next ID: 4 # Reference to composite ApplicationTemplate. When specified, the template components will be imported into their equivalent UnitKind, Release and Blueprint resources. Deleted references will not delete imported resources. Should only be specified on source regions, and be unspecified on replica regions. + "applicationTemplate": "A String", # Required. Reference to the ApplicationTemplate resource. + "revision": "A String", # Revision of the ApplicationTemplate to use. Changes to revision will trigger manual resynchronization. If empty, ApplicationTemplate will be ignored. + "syncOperation": "A String", # Output only. Reference to on-going AppTemplate import and replication operation (i.e. the operation_id for the long-running operation). This field is opaque for external usage. + }, + "blueprintRepo": "A String", # Output only. Name of repository in Artifact Registry for system-generated Blueprints, eg. Blueprints of imported ApplicationTemplates. + "conditions": [ # Output only. A set of conditions which indicate the various conditions this resource can have. + { # SaasCondition describes the status of a Saas. + "lastTransitionTime": "A String", # Required. Last time the condition transited from one status to another. + "message": "A String", # Required. Human readable message indicating details about the last transition. + "reason": "A String", # Required. Brief reason for the condition's last transition. + "status": "A String", # Required. Status of the condition. + "type": "A String", # Required. Type of the condition. + }, + ], "createTime": "A String", # Output only. The timestamp when the resource was created. + "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). # Output only. If the state is FAILED, the corresponding error code and message. Defaults to code=OK for all other states. + "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. + }, "etag": "A String", # Output only. An opaque value that uniquely identifies a version or generation of a resource. It can be used to confirm that the client and server agree on the ordering of a resource being written. "labels": { # Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels. "a_key": "A String", @@ -251,6 +350,7 @@

Method Details

}, ], "name": "A String", # Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/saas/{saas}" + "state": "A String", # Output only. State of the Saas. It is always in ACTIVE state if the application_template is empty. "uid": "A String", # Output only. The unique identifier of the resource. UID is unique in the time and space for this resource within the scope of the service. It is typically generated by the server on successful creation of a resource and must not be changed. UID is used to uniquely identify resources with resource name reuses. This should be a UUID4. "updateTime": "A String", # Output only. The timestamp when the resource was last updated. Any change to the resource made by users must refresh this value. Changes to a resource made by the service should refresh this value. }, @@ -288,7 +388,31 @@

Method Details

"annotations": { # Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations "a_key": "A String", }, + "applicationTemplate": { # CompositeRef represents a reference to a composite resource. Next ID: 4 # Reference to composite ApplicationTemplate. When specified, the template components will be imported into their equivalent UnitKind, Release and Blueprint resources. Deleted references will not delete imported resources. Should only be specified on source regions, and be unspecified on replica regions. + "applicationTemplate": "A String", # Required. Reference to the ApplicationTemplate resource. + "revision": "A String", # Revision of the ApplicationTemplate to use. Changes to revision will trigger manual resynchronization. If empty, ApplicationTemplate will be ignored. + "syncOperation": "A String", # Output only. Reference to on-going AppTemplate import and replication operation (i.e. the operation_id for the long-running operation). This field is opaque for external usage. + }, + "blueprintRepo": "A String", # Output only. Name of repository in Artifact Registry for system-generated Blueprints, eg. Blueprints of imported ApplicationTemplates. + "conditions": [ # Output only. A set of conditions which indicate the various conditions this resource can have. + { # SaasCondition describes the status of a Saas. + "lastTransitionTime": "A String", # Required. Last time the condition transited from one status to another. + "message": "A String", # Required. Human readable message indicating details about the last transition. + "reason": "A String", # Required. Brief reason for the condition's last transition. + "status": "A String", # Required. Status of the condition. + "type": "A String", # Required. Type of the condition. + }, + ], "createTime": "A String", # Output only. The timestamp when the resource was created. + "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). # Output only. If the state is FAILED, the corresponding error code and message. Defaults to code=OK for all other states. + "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. + }, "etag": "A String", # Output only. An opaque value that uniquely identifies a version or generation of a resource. It can be used to confirm that the client and server agree on the ordering of a resource being written. "labels": { # Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels. "a_key": "A String", @@ -299,6 +423,7 @@

Method Details

}, ], "name": "A String", # Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/saas/{saas}" + "state": "A String", # Output only. State of the Saas. It is always in ACTIVE state if the application_template is empty. "uid": "A String", # Output only. The unique identifier of the resource. UID is unique in the time and space for this resource within the scope of the service. It is typically generated by the server on successful creation of a resource and must not be changed. UID is used to uniquely identify resources with resource name reuses. This should be a UUID4. "updateTime": "A String", # Output only. The timestamp when the resource was last updated. Any change to the resource made by users must refresh this value. Changes to a resource made by the service should refresh this value. } @@ -318,7 +443,31 @@

Method Details

"annotations": { # Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations "a_key": "A String", }, + "applicationTemplate": { # CompositeRef represents a reference to a composite resource. Next ID: 4 # Reference to composite ApplicationTemplate. When specified, the template components will be imported into their equivalent UnitKind, Release and Blueprint resources. Deleted references will not delete imported resources. Should only be specified on source regions, and be unspecified on replica regions. + "applicationTemplate": "A String", # Required. Reference to the ApplicationTemplate resource. + "revision": "A String", # Revision of the ApplicationTemplate to use. Changes to revision will trigger manual resynchronization. If empty, ApplicationTemplate will be ignored. + "syncOperation": "A String", # Output only. Reference to on-going AppTemplate import and replication operation (i.e. the operation_id for the long-running operation). This field is opaque for external usage. + }, + "blueprintRepo": "A String", # Output only. Name of repository in Artifact Registry for system-generated Blueprints, eg. Blueprints of imported ApplicationTemplates. + "conditions": [ # Output only. A set of conditions which indicate the various conditions this resource can have. + { # SaasCondition describes the status of a Saas. + "lastTransitionTime": "A String", # Required. Last time the condition transited from one status to another. + "message": "A String", # Required. Human readable message indicating details about the last transition. + "reason": "A String", # Required. Brief reason for the condition's last transition. + "status": "A String", # Required. Status of the condition. + "type": "A String", # Required. Type of the condition. + }, + ], "createTime": "A String", # Output only. The timestamp when the resource was created. + "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). # Output only. If the state is FAILED, the corresponding error code and message. Defaults to code=OK for all other states. + "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. + }, "etag": "A String", # Output only. An opaque value that uniquely identifies a version or generation of a resource. It can be used to confirm that the client and server agree on the ordering of a resource being written. "labels": { # Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels. "a_key": "A String", @@ -329,6 +478,7 @@

Method Details

}, ], "name": "A String", # Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/saas/{saas}" + "state": "A String", # Output only. State of the Saas. It is always in ACTIVE state if the application_template is empty. "uid": "A String", # Output only. The unique identifier of the resource. UID is unique in the time and space for this resource within the scope of the service. It is typically generated by the server on successful creation of a resource and must not be changed. UID is used to uniquely identify resources with resource name reuses. This should be a UUID4. "updateTime": "A String", # Output only. The timestamp when the resource was last updated. Any change to the resource made by users must refresh this value. Changes to a resource made by the service should refresh this value. }
diff --git a/docs/dyn/saasservicemgmt_v1beta1.projects.locations.unitKinds.html b/docs/dyn/saasservicemgmt_v1beta1.projects.locations.unitKinds.html index 8681d4ba1b..390512d3d9 100644 --- a/docs/dyn/saasservicemgmt_v1beta1.projects.locations.unitKinds.html +++ b/docs/dyn/saasservicemgmt_v1beta1.projects.locations.unitKinds.html @@ -114,6 +114,21 @@

Method Details

"annotations": { # Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations "a_key": "A String", }, + "appParams": { # AppParams contains the parameters for creating an AppHub Application. # AppParams contains the parameters for creating an AppHub Application. + "group": "A String", # Grouping used to construct the name of the AppHub Application. Multiple UnitKinds can specify the same group to use the same Application across their respective units. Corresponds to the app_boundary_id in the ADC composite ApplicationTemplate. Defaults to UnitKind.name + "scope": { # Scope of an application. # Corresponds to the scope in the ADC composite ApplicationTemplate. Defaults to REGIONAL. + "type": "A String", # Required. Scope Type. + }, + }, + "applicationTemplateComponent": { # ComponentRef represents a reference to a component resource. Next ID: 4 # Output only. Reference to component and revision in a composite ApplicationTemplate. + "component": "A String", # Name of the component in composite.Components + "compositeRef": { # CompositeRef represents a reference to a composite resource. Next ID: 4 # Reference to the Composite ApplicationTemplate. + "applicationTemplate": "A String", # Required. Reference to the ApplicationTemplate resource. + "revision": "A String", # Revision of the ApplicationTemplate to use. Changes to revision will trigger manual resynchronization. If empty, ApplicationTemplate will be ignored. + "syncOperation": "A String", # Output only. Reference to on-going AppTemplate import and replication operation (i.e. the operation_id for the long-running operation). This field is opaque for external usage. + }, + "revision": "A String", # Revision of the component. If the component does not have a revision, this field will be explicitly set to the revision of the composite ApplicationTemplate. + }, "createTime": "A String", # Output only. The timestamp when the resource was created. "defaultRelease": "A String", # Optional. A reference to the Release object to use as default for creating new units of this UnitKind (optional). If not specified, a new unit must explicitly reference which release to use for its creation. "dependencies": [ # Optional. Immutable. List of other unit kinds that this release will depend on. Dependencies will be automatically provisioned if not found. Maximum 10. @@ -175,6 +190,21 @@

Method Details

"annotations": { # Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations "a_key": "A String", }, + "appParams": { # AppParams contains the parameters for creating an AppHub Application. # AppParams contains the parameters for creating an AppHub Application. + "group": "A String", # Grouping used to construct the name of the AppHub Application. Multiple UnitKinds can specify the same group to use the same Application across their respective units. Corresponds to the app_boundary_id in the ADC composite ApplicationTemplate. Defaults to UnitKind.name + "scope": { # Scope of an application. # Corresponds to the scope in the ADC composite ApplicationTemplate. Defaults to REGIONAL. + "type": "A String", # Required. Scope Type. + }, + }, + "applicationTemplateComponent": { # ComponentRef represents a reference to a component resource. Next ID: 4 # Output only. Reference to component and revision in a composite ApplicationTemplate. + "component": "A String", # Name of the component in composite.Components + "compositeRef": { # CompositeRef represents a reference to a composite resource. Next ID: 4 # Reference to the Composite ApplicationTemplate. + "applicationTemplate": "A String", # Required. Reference to the ApplicationTemplate resource. + "revision": "A String", # Revision of the ApplicationTemplate to use. Changes to revision will trigger manual resynchronization. If empty, ApplicationTemplate will be ignored. + "syncOperation": "A String", # Output only. Reference to on-going AppTemplate import and replication operation (i.e. the operation_id for the long-running operation). This field is opaque for external usage. + }, + "revision": "A String", # Revision of the component. If the component does not have a revision, this field will be explicitly set to the revision of the composite ApplicationTemplate. + }, "createTime": "A String", # Output only. The timestamp when the resource was created. "defaultRelease": "A String", # Optional. A reference to the Release object to use as default for creating new units of this UnitKind (optional). If not specified, a new unit must explicitly reference which release to use for its creation. "dependencies": [ # Optional. Immutable. List of other unit kinds that this release will depend on. Dependencies will be automatically provisioned if not found. Maximum 10. @@ -261,6 +291,21 @@

Method Details

"annotations": { # Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations "a_key": "A String", }, + "appParams": { # AppParams contains the parameters for creating an AppHub Application. # AppParams contains the parameters for creating an AppHub Application. + "group": "A String", # Grouping used to construct the name of the AppHub Application. Multiple UnitKinds can specify the same group to use the same Application across their respective units. Corresponds to the app_boundary_id in the ADC composite ApplicationTemplate. Defaults to UnitKind.name + "scope": { # Scope of an application. # Corresponds to the scope in the ADC composite ApplicationTemplate. Defaults to REGIONAL. + "type": "A String", # Required. Scope Type. + }, + }, + "applicationTemplateComponent": { # ComponentRef represents a reference to a component resource. Next ID: 4 # Output only. Reference to component and revision in a composite ApplicationTemplate. + "component": "A String", # Name of the component in composite.Components + "compositeRef": { # CompositeRef represents a reference to a composite resource. Next ID: 4 # Reference to the Composite ApplicationTemplate. + "applicationTemplate": "A String", # Required. Reference to the ApplicationTemplate resource. + "revision": "A String", # Revision of the ApplicationTemplate to use. Changes to revision will trigger manual resynchronization. If empty, ApplicationTemplate will be ignored. + "syncOperation": "A String", # Output only. Reference to on-going AppTemplate import and replication operation (i.e. the operation_id for the long-running operation). This field is opaque for external usage. + }, + "revision": "A String", # Revision of the component. If the component does not have a revision, this field will be explicitly set to the revision of the composite ApplicationTemplate. + }, "createTime": "A String", # Output only. The timestamp when the resource was created. "defaultRelease": "A String", # Optional. A reference to the Release object to use as default for creating new units of this UnitKind (optional). If not specified, a new unit must explicitly reference which release to use for its creation. "dependencies": [ # Optional. Immutable. List of other unit kinds that this release will depend on. Dependencies will be automatically provisioned if not found. Maximum 10. @@ -333,6 +378,21 @@

Method Details

"annotations": { # Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations "a_key": "A String", }, + "appParams": { # AppParams contains the parameters for creating an AppHub Application. # AppParams contains the parameters for creating an AppHub Application. + "group": "A String", # Grouping used to construct the name of the AppHub Application. Multiple UnitKinds can specify the same group to use the same Application across their respective units. Corresponds to the app_boundary_id in the ADC composite ApplicationTemplate. Defaults to UnitKind.name + "scope": { # Scope of an application. # Corresponds to the scope in the ADC composite ApplicationTemplate. Defaults to REGIONAL. + "type": "A String", # Required. Scope Type. + }, + }, + "applicationTemplateComponent": { # ComponentRef represents a reference to a component resource. Next ID: 4 # Output only. Reference to component and revision in a composite ApplicationTemplate. + "component": "A String", # Name of the component in composite.Components + "compositeRef": { # CompositeRef represents a reference to a composite resource. Next ID: 4 # Reference to the Composite ApplicationTemplate. + "applicationTemplate": "A String", # Required. Reference to the ApplicationTemplate resource. + "revision": "A String", # Revision of the ApplicationTemplate to use. Changes to revision will trigger manual resynchronization. If empty, ApplicationTemplate will be ignored. + "syncOperation": "A String", # Output only. Reference to on-going AppTemplate import and replication operation (i.e. the operation_id for the long-running operation). This field is opaque for external usage. + }, + "revision": "A String", # Revision of the component. If the component does not have a revision, this field will be explicitly set to the revision of the composite ApplicationTemplate. + }, "createTime": "A String", # Output only. The timestamp when the resource was created. "defaultRelease": "A String", # Optional. A reference to the Release object to use as default for creating new units of this UnitKind (optional). If not specified, a new unit must explicitly reference which release to use for its creation. "dependencies": [ # Optional. Immutable. List of other unit kinds that this release will depend on. Dependencies will be automatically provisioned if not found. Maximum 10. @@ -412,6 +472,21 @@

Method Details

"annotations": { # Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations "a_key": "A String", }, + "appParams": { # AppParams contains the parameters for creating an AppHub Application. # AppParams contains the parameters for creating an AppHub Application. + "group": "A String", # Grouping used to construct the name of the AppHub Application. Multiple UnitKinds can specify the same group to use the same Application across their respective units. Corresponds to the app_boundary_id in the ADC composite ApplicationTemplate. Defaults to UnitKind.name + "scope": { # Scope of an application. # Corresponds to the scope in the ADC composite ApplicationTemplate. Defaults to REGIONAL. + "type": "A String", # Required. Scope Type. + }, + }, + "applicationTemplateComponent": { # ComponentRef represents a reference to a component resource. Next ID: 4 # Output only. Reference to component and revision in a composite ApplicationTemplate. + "component": "A String", # Name of the component in composite.Components + "compositeRef": { # CompositeRef represents a reference to a composite resource. Next ID: 4 # Reference to the Composite ApplicationTemplate. + "applicationTemplate": "A String", # Required. Reference to the ApplicationTemplate resource. + "revision": "A String", # Revision of the ApplicationTemplate to use. Changes to revision will trigger manual resynchronization. If empty, ApplicationTemplate will be ignored. + "syncOperation": "A String", # Output only. Reference to on-going AppTemplate import and replication operation (i.e. the operation_id for the long-running operation). This field is opaque for external usage. + }, + "revision": "A String", # Revision of the component. If the component does not have a revision, this field will be explicitly set to the revision of the composite ApplicationTemplate. + }, "createTime": "A String", # Output only. The timestamp when the resource was created. "defaultRelease": "A String", # Optional. A reference to the Release object to use as default for creating new units of this UnitKind (optional). If not specified, a new unit must explicitly reference which release to use for its creation. "dependencies": [ # Optional. Immutable. List of other unit kinds that this release will depend on. Dependencies will be automatically provisioned if not found. Maximum 10. @@ -473,6 +548,21 @@

Method Details

"annotations": { # Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations "a_key": "A String", }, + "appParams": { # AppParams contains the parameters for creating an AppHub Application. # AppParams contains the parameters for creating an AppHub Application. + "group": "A String", # Grouping used to construct the name of the AppHub Application. Multiple UnitKinds can specify the same group to use the same Application across their respective units. Corresponds to the app_boundary_id in the ADC composite ApplicationTemplate. Defaults to UnitKind.name + "scope": { # Scope of an application. # Corresponds to the scope in the ADC composite ApplicationTemplate. Defaults to REGIONAL. + "type": "A String", # Required. Scope Type. + }, + }, + "applicationTemplateComponent": { # ComponentRef represents a reference to a component resource. Next ID: 4 # Output only. Reference to component and revision in a composite ApplicationTemplate. + "component": "A String", # Name of the component in composite.Components + "compositeRef": { # CompositeRef represents a reference to a composite resource. Next ID: 4 # Reference to the Composite ApplicationTemplate. + "applicationTemplate": "A String", # Required. Reference to the ApplicationTemplate resource. + "revision": "A String", # Revision of the ApplicationTemplate to use. Changes to revision will trigger manual resynchronization. If empty, ApplicationTemplate will be ignored. + "syncOperation": "A String", # Output only. Reference to on-going AppTemplate import and replication operation (i.e. the operation_id for the long-running operation). This field is opaque for external usage. + }, + "revision": "A String", # Revision of the component. If the component does not have a revision, this field will be explicitly set to the revision of the composite ApplicationTemplate. + }, "createTime": "A String", # Output only. The timestamp when the resource was created. "defaultRelease": "A String", # Optional. A reference to the Release object to use as default for creating new units of this UnitKind (optional). If not specified, a new unit must explicitly reference which release to use for its creation. "dependencies": [ # Optional. Immutable. List of other unit kinds that this release will depend on. Dependencies will be automatically provisioned if not found. Maximum 10. diff --git a/docs/dyn/saasservicemgmt_v1beta1.projects.locations.units.html b/docs/dyn/saasservicemgmt_v1beta1.projects.locations.units.html index ff059ab625..6517328f00 100644 --- a/docs/dyn/saasservicemgmt_v1beta1.projects.locations.units.html +++ b/docs/dyn/saasservicemgmt_v1beta1.projects.locations.units.html @@ -114,6 +114,7 @@

Method Details

"annotations": { # Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations "a_key": "A String", }, + "application": "A String", # Optional. Reference to the AppHub Application this unit belongs to. All resources deployed in this Unit will be associated with the specified Application. "conditions": [ # Optional. Output only. A set of conditions which indicate the various conditions this resource can have. { # UnitCondition describes the status of an Unit. UnitCondition is individual components that contribute to an overall state. "lastTransitionTime": "A String", # Required. Last time the condition transited from one status to another. @@ -195,6 +196,7 @@

Method Details

"annotations": { # Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations "a_key": "A String", }, + "application": "A String", # Optional. Reference to the AppHub Application this unit belongs to. All resources deployed in this Unit will be associated with the specified Application. "conditions": [ # Optional. Output only. A set of conditions which indicate the various conditions this resource can have. { # UnitCondition describes the status of an Unit. UnitCondition is individual components that contribute to an overall state. "lastTransitionTime": "A String", # Required. Last time the condition transited from one status to another. @@ -301,6 +303,7 @@

Method Details

"annotations": { # Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations "a_key": "A String", }, + "application": "A String", # Optional. Reference to the AppHub Application this unit belongs to. All resources deployed in this Unit will be associated with the specified Application. "conditions": [ # Optional. Output only. A set of conditions which indicate the various conditions this resource can have. { # UnitCondition describes the status of an Unit. UnitCondition is individual components that contribute to an overall state. "lastTransitionTime": "A String", # Required. Last time the condition transited from one status to another. @@ -393,6 +396,7 @@

Method Details

"annotations": { # Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations "a_key": "A String", }, + "application": "A String", # Optional. Reference to the AppHub Application this unit belongs to. All resources deployed in this Unit will be associated with the specified Application. "conditions": [ # Optional. Output only. A set of conditions which indicate the various conditions this resource can have. { # UnitCondition describes the status of an Unit. UnitCondition is individual components that contribute to an overall state. "lastTransitionTime": "A String", # Required. Last time the condition transited from one status to another. @@ -492,6 +496,7 @@

Method Details

"annotations": { # Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations "a_key": "A String", }, + "application": "A String", # Optional. Reference to the AppHub Application this unit belongs to. All resources deployed in this Unit will be associated with the specified Application. "conditions": [ # Optional. Output only. A set of conditions which indicate the various conditions this resource can have. { # UnitCondition describes the status of an Unit. UnitCondition is individual components that contribute to an overall state. "lastTransitionTime": "A String", # Required. Last time the condition transited from one status to another. @@ -573,6 +578,7 @@

Method Details

"annotations": { # Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations "a_key": "A String", }, + "application": "A String", # Optional. Reference to the AppHub Application this unit belongs to. All resources deployed in this Unit will be associated with the specified Application. "conditions": [ # Optional. Output only. A set of conditions which indicate the various conditions this resource can have. { # UnitCondition describes the status of an Unit. UnitCondition is individual components that contribute to an overall state. "lastTransitionTime": "A String", # Required. Last time the condition transited from one status to another. diff --git a/docs/dyn/securitycenter_v1.folders.securityHealthAnalyticsSettings.customModules.html b/docs/dyn/securitycenter_v1.folders.securityHealthAnalyticsSettings.customModules.html index 6b5c801b61..fdd9a409fd 100644 --- a/docs/dyn/securitycenter_v1.folders.securityHealthAnalyticsSettings.customModules.html +++ b/docs/dyn/securitycenter_v1.folders.securityHealthAnalyticsSettings.customModules.html @@ -862,6 +862,13 @@

Method Details

"version": "A String", # The version of the database, for example, POSTGRES_14. See [the complete list](https://cloud.google.com/sql/docs/mysql/admin-api/rest/v1/SqlDatabaseVersion). }, "description": "A String", # Contains more details about the finding. + "discoveredWorkload": { # Represents discovered, customer managed workload that is not registered with the respective GCP service. # DiscoveredWorkload associated with the finding. + "confidence": "A String", # The confidence in detection of this workload. + "detectedRelevantHardware": True or False, # A boolean flag set to true if associated hardware strongly predicts the workload type. + "detectedRelevantKeywords": True or False, # A boolean flag set to true if associated keywords strongly predict the workload type. + "detectedRelevantPackages": True or False, # A boolean flag set to true if installed packages strongly predict the workload type. + "workloadType": "A String", # The type of workload. + }, "disk": { # Contains information about the disk associated with the finding. # Disk associated with the finding. "name": "A String", # The name of the disk, for example, "https://www.googleapis.com/compute/v1/projects/{project-id}/zones/{zone-id}/disks/{disk-id}". }, diff --git a/docs/dyn/securitycenter_v1.folders.sources.findings.html b/docs/dyn/securitycenter_v1.folders.sources.findings.html index aa4009012c..474ecfa757 100644 --- a/docs/dyn/securitycenter_v1.folders.sources.findings.html +++ b/docs/dyn/securitycenter_v1.folders.sources.findings.html @@ -431,6 +431,13 @@

Method Details

"version": "A String", # The version of the database, for example, POSTGRES_14. See [the complete list](https://cloud.google.com/sql/docs/mysql/admin-api/rest/v1/SqlDatabaseVersion). }, "description": "A String", # Contains more details about the finding. + "discoveredWorkload": { # Represents discovered, customer managed workload that is not registered with the respective GCP service. # DiscoveredWorkload associated with the finding. + "confidence": "A String", # The confidence in detection of this workload. + "detectedRelevantHardware": True or False, # A boolean flag set to true if associated hardware strongly predicts the workload type. + "detectedRelevantKeywords": True or False, # A boolean flag set to true if associated keywords strongly predict the workload type. + "detectedRelevantPackages": True or False, # A boolean flag set to true if installed packages strongly predict the workload type. + "workloadType": "A String", # The type of workload. + }, "disk": { # Contains information about the disk associated with the finding. # Disk associated with the finding. "name": "A String", # The name of the disk, for example, "https://www.googleapis.com/compute/v1/projects/{project-id}/zones/{zone-id}/disks/{disk-id}". }, @@ -1373,6 +1380,13 @@

Method Details

"version": "A String", # The version of the database, for example, POSTGRES_14. See [the complete list](https://cloud.google.com/sql/docs/mysql/admin-api/rest/v1/SqlDatabaseVersion). }, "description": "A String", # Contains more details about the finding. + "discoveredWorkload": { # Represents discovered, customer managed workload that is not registered with the respective GCP service. # DiscoveredWorkload associated with the finding. + "confidence": "A String", # The confidence in detection of this workload. + "detectedRelevantHardware": True or False, # A boolean flag set to true if associated hardware strongly predicts the workload type. + "detectedRelevantKeywords": True or False, # A boolean flag set to true if associated keywords strongly predict the workload type. + "detectedRelevantPackages": True or False, # A boolean flag set to true if installed packages strongly predict the workload type. + "workloadType": "A String", # The type of workload. + }, "disk": { # Contains information about the disk associated with the finding. # Disk associated with the finding. "name": "A String", # The name of the disk, for example, "https://www.googleapis.com/compute/v1/projects/{project-id}/zones/{zone-id}/disks/{disk-id}". }, @@ -2171,6 +2185,13 @@

Method Details

"version": "A String", # The version of the database, for example, POSTGRES_14. See [the complete list](https://cloud.google.com/sql/docs/mysql/admin-api/rest/v1/SqlDatabaseVersion). }, "description": "A String", # Contains more details about the finding. + "discoveredWorkload": { # Represents discovered, customer managed workload that is not registered with the respective GCP service. # DiscoveredWorkload associated with the finding. + "confidence": "A String", # The confidence in detection of this workload. + "detectedRelevantHardware": True or False, # A boolean flag set to true if associated hardware strongly predicts the workload type. + "detectedRelevantKeywords": True or False, # A boolean flag set to true if associated keywords strongly predict the workload type. + "detectedRelevantPackages": True or False, # A boolean flag set to true if installed packages strongly predict the workload type. + "workloadType": "A String", # The type of workload. + }, "disk": { # Contains information about the disk associated with the finding. # Disk associated with the finding. "name": "A String", # The name of the disk, for example, "https://www.googleapis.com/compute/v1/projects/{project-id}/zones/{zone-id}/disks/{disk-id}". }, @@ -2982,6 +3003,13 @@

Method Details

"version": "A String", # The version of the database, for example, POSTGRES_14. See [the complete list](https://cloud.google.com/sql/docs/mysql/admin-api/rest/v1/SqlDatabaseVersion). }, "description": "A String", # Contains more details about the finding. + "discoveredWorkload": { # Represents discovered, customer managed workload that is not registered with the respective GCP service. # DiscoveredWorkload associated with the finding. + "confidence": "A String", # The confidence in detection of this workload. + "detectedRelevantHardware": True or False, # A boolean flag set to true if associated hardware strongly predicts the workload type. + "detectedRelevantKeywords": True or False, # A boolean flag set to true if associated keywords strongly predict the workload type. + "detectedRelevantPackages": True or False, # A boolean flag set to true if installed packages strongly predict the workload type. + "workloadType": "A String", # The type of workload. + }, "disk": { # Contains information about the disk associated with the finding. # Disk associated with the finding. "name": "A String", # The name of the disk, for example, "https://www.googleapis.com/compute/v1/projects/{project-id}/zones/{zone-id}/disks/{disk-id}". }, @@ -3794,6 +3822,13 @@

Method Details

"version": "A String", # The version of the database, for example, POSTGRES_14. See [the complete list](https://cloud.google.com/sql/docs/mysql/admin-api/rest/v1/SqlDatabaseVersion). }, "description": "A String", # Contains more details about the finding. + "discoveredWorkload": { # Represents discovered, customer managed workload that is not registered with the respective GCP service. # DiscoveredWorkload associated with the finding. + "confidence": "A String", # The confidence in detection of this workload. + "detectedRelevantHardware": True or False, # A boolean flag set to true if associated hardware strongly predicts the workload type. + "detectedRelevantKeywords": True or False, # A boolean flag set to true if associated keywords strongly predict the workload type. + "detectedRelevantPackages": True or False, # A boolean flag set to true if installed packages strongly predict the workload type. + "workloadType": "A String", # The type of workload. + }, "disk": { # Contains information about the disk associated with the finding. # Disk associated with the finding. "name": "A String", # The name of the disk, for example, "https://www.googleapis.com/compute/v1/projects/{project-id}/zones/{zone-id}/disks/{disk-id}". }, diff --git a/docs/dyn/securitycenter_v1.organizations.securityHealthAnalyticsSettings.customModules.html b/docs/dyn/securitycenter_v1.organizations.securityHealthAnalyticsSettings.customModules.html index 5770b8d885..c2f59c720c 100644 --- a/docs/dyn/securitycenter_v1.organizations.securityHealthAnalyticsSettings.customModules.html +++ b/docs/dyn/securitycenter_v1.organizations.securityHealthAnalyticsSettings.customModules.html @@ -862,6 +862,13 @@

Method Details

"version": "A String", # The version of the database, for example, POSTGRES_14. See [the complete list](https://cloud.google.com/sql/docs/mysql/admin-api/rest/v1/SqlDatabaseVersion). }, "description": "A String", # Contains more details about the finding. + "discoveredWorkload": { # Represents discovered, customer managed workload that is not registered with the respective GCP service. # DiscoveredWorkload associated with the finding. + "confidence": "A String", # The confidence in detection of this workload. + "detectedRelevantHardware": True or False, # A boolean flag set to true if associated hardware strongly predicts the workload type. + "detectedRelevantKeywords": True or False, # A boolean flag set to true if associated keywords strongly predict the workload type. + "detectedRelevantPackages": True or False, # A boolean flag set to true if installed packages strongly predict the workload type. + "workloadType": "A String", # The type of workload. + }, "disk": { # Contains information about the disk associated with the finding. # Disk associated with the finding. "name": "A String", # The name of the disk, for example, "https://www.googleapis.com/compute/v1/projects/{project-id}/zones/{zone-id}/disks/{disk-id}". }, diff --git a/docs/dyn/securitycenter_v1.organizations.sources.findings.html b/docs/dyn/securitycenter_v1.organizations.sources.findings.html index e376907312..ed1f1f0cf8 100644 --- a/docs/dyn/securitycenter_v1.organizations.sources.findings.html +++ b/docs/dyn/securitycenter_v1.organizations.sources.findings.html @@ -364,6 +364,13 @@

Method Details

"version": "A String", # The version of the database, for example, POSTGRES_14. See [the complete list](https://cloud.google.com/sql/docs/mysql/admin-api/rest/v1/SqlDatabaseVersion). }, "description": "A String", # Contains more details about the finding. + "discoveredWorkload": { # Represents discovered, customer managed workload that is not registered with the respective GCP service. # DiscoveredWorkload associated with the finding. + "confidence": "A String", # The confidence in detection of this workload. + "detectedRelevantHardware": True or False, # A boolean flag set to true if associated hardware strongly predicts the workload type. + "detectedRelevantKeywords": True or False, # A boolean flag set to true if associated keywords strongly predict the workload type. + "detectedRelevantPackages": True or False, # A boolean flag set to true if installed packages strongly predict the workload type. + "workloadType": "A String", # The type of workload. + }, "disk": { # Contains information about the disk associated with the finding. # Disk associated with the finding. "name": "A String", # The name of the disk, for example, "https://www.googleapis.com/compute/v1/projects/{project-id}/zones/{zone-id}/disks/{disk-id}". }, @@ -1162,6 +1169,13 @@

Method Details

"version": "A String", # The version of the database, for example, POSTGRES_14. See [the complete list](https://cloud.google.com/sql/docs/mysql/admin-api/rest/v1/SqlDatabaseVersion). }, "description": "A String", # Contains more details about the finding. + "discoveredWorkload": { # Represents discovered, customer managed workload that is not registered with the respective GCP service. # DiscoveredWorkload associated with the finding. + "confidence": "A String", # The confidence in detection of this workload. + "detectedRelevantHardware": True or False, # A boolean flag set to true if associated hardware strongly predicts the workload type. + "detectedRelevantKeywords": True or False, # A boolean flag set to true if associated keywords strongly predict the workload type. + "detectedRelevantPackages": True or False, # A boolean flag set to true if installed packages strongly predict the workload type. + "workloadType": "A String", # The type of workload. + }, "disk": { # Contains information about the disk associated with the finding. # Disk associated with the finding. "name": "A String", # The name of the disk, for example, "https://www.googleapis.com/compute/v1/projects/{project-id}/zones/{zone-id}/disks/{disk-id}". }, @@ -2031,6 +2045,13 @@

Method Details

"version": "A String", # The version of the database, for example, POSTGRES_14. See [the complete list](https://cloud.google.com/sql/docs/mysql/admin-api/rest/v1/SqlDatabaseVersion). }, "description": "A String", # Contains more details about the finding. + "discoveredWorkload": { # Represents discovered, customer managed workload that is not registered with the respective GCP service. # DiscoveredWorkload associated with the finding. + "confidence": "A String", # The confidence in detection of this workload. + "detectedRelevantHardware": True or False, # A boolean flag set to true if associated hardware strongly predicts the workload type. + "detectedRelevantKeywords": True or False, # A boolean flag set to true if associated keywords strongly predict the workload type. + "detectedRelevantPackages": True or False, # A boolean flag set to true if installed packages strongly predict the workload type. + "workloadType": "A String", # The type of workload. + }, "disk": { # Contains information about the disk associated with the finding. # Disk associated with the finding. "name": "A String", # The name of the disk, for example, "https://www.googleapis.com/compute/v1/projects/{project-id}/zones/{zone-id}/disks/{disk-id}". }, @@ -2973,6 +2994,13 @@

Method Details

"version": "A String", # The version of the database, for example, POSTGRES_14. See [the complete list](https://cloud.google.com/sql/docs/mysql/admin-api/rest/v1/SqlDatabaseVersion). }, "description": "A String", # Contains more details about the finding. + "discoveredWorkload": { # Represents discovered, customer managed workload that is not registered with the respective GCP service. # DiscoveredWorkload associated with the finding. + "confidence": "A String", # The confidence in detection of this workload. + "detectedRelevantHardware": True or False, # A boolean flag set to true if associated hardware strongly predicts the workload type. + "detectedRelevantKeywords": True or False, # A boolean flag set to true if associated keywords strongly predict the workload type. + "detectedRelevantPackages": True or False, # A boolean flag set to true if installed packages strongly predict the workload type. + "workloadType": "A String", # The type of workload. + }, "disk": { # Contains information about the disk associated with the finding. # Disk associated with the finding. "name": "A String", # The name of the disk, for example, "https://www.googleapis.com/compute/v1/projects/{project-id}/zones/{zone-id}/disks/{disk-id}". }, @@ -3771,6 +3799,13 @@

Method Details

"version": "A String", # The version of the database, for example, POSTGRES_14. See [the complete list](https://cloud.google.com/sql/docs/mysql/admin-api/rest/v1/SqlDatabaseVersion). }, "description": "A String", # Contains more details about the finding. + "discoveredWorkload": { # Represents discovered, customer managed workload that is not registered with the respective GCP service. # DiscoveredWorkload associated with the finding. + "confidence": "A String", # The confidence in detection of this workload. + "detectedRelevantHardware": True or False, # A boolean flag set to true if associated hardware strongly predicts the workload type. + "detectedRelevantKeywords": True or False, # A boolean flag set to true if associated keywords strongly predict the workload type. + "detectedRelevantPackages": True or False, # A boolean flag set to true if installed packages strongly predict the workload type. + "workloadType": "A String", # The type of workload. + }, "disk": { # Contains information about the disk associated with the finding. # Disk associated with the finding. "name": "A String", # The name of the disk, for example, "https://www.googleapis.com/compute/v1/projects/{project-id}/zones/{zone-id}/disks/{disk-id}". }, @@ -4582,6 +4617,13 @@

Method Details

"version": "A String", # The version of the database, for example, POSTGRES_14. See [the complete list](https://cloud.google.com/sql/docs/mysql/admin-api/rest/v1/SqlDatabaseVersion). }, "description": "A String", # Contains more details about the finding. + "discoveredWorkload": { # Represents discovered, customer managed workload that is not registered with the respective GCP service. # DiscoveredWorkload associated with the finding. + "confidence": "A String", # The confidence in detection of this workload. + "detectedRelevantHardware": True or False, # A boolean flag set to true if associated hardware strongly predicts the workload type. + "detectedRelevantKeywords": True or False, # A boolean flag set to true if associated keywords strongly predict the workload type. + "detectedRelevantPackages": True or False, # A boolean flag set to true if installed packages strongly predict the workload type. + "workloadType": "A String", # The type of workload. + }, "disk": { # Contains information about the disk associated with the finding. # Disk associated with the finding. "name": "A String", # The name of the disk, for example, "https://www.googleapis.com/compute/v1/projects/{project-id}/zones/{zone-id}/disks/{disk-id}". }, @@ -5394,6 +5436,13 @@

Method Details

"version": "A String", # The version of the database, for example, POSTGRES_14. See [the complete list](https://cloud.google.com/sql/docs/mysql/admin-api/rest/v1/SqlDatabaseVersion). }, "description": "A String", # Contains more details about the finding. + "discoveredWorkload": { # Represents discovered, customer managed workload that is not registered with the respective GCP service. # DiscoveredWorkload associated with the finding. + "confidence": "A String", # The confidence in detection of this workload. + "detectedRelevantHardware": True or False, # A boolean flag set to true if associated hardware strongly predicts the workload type. + "detectedRelevantKeywords": True or False, # A boolean flag set to true if associated keywords strongly predict the workload type. + "detectedRelevantPackages": True or False, # A boolean flag set to true if installed packages strongly predict the workload type. + "workloadType": "A String", # The type of workload. + }, "disk": { # Contains information about the disk associated with the finding. # Disk associated with the finding. "name": "A String", # The name of the disk, for example, "https://www.googleapis.com/compute/v1/projects/{project-id}/zones/{zone-id}/disks/{disk-id}". }, diff --git a/docs/dyn/securitycenter_v1.projects.securityHealthAnalyticsSettings.customModules.html b/docs/dyn/securitycenter_v1.projects.securityHealthAnalyticsSettings.customModules.html index 7829a1f3cf..f3c4c60d50 100644 --- a/docs/dyn/securitycenter_v1.projects.securityHealthAnalyticsSettings.customModules.html +++ b/docs/dyn/securitycenter_v1.projects.securityHealthAnalyticsSettings.customModules.html @@ -862,6 +862,13 @@

Method Details

"version": "A String", # The version of the database, for example, POSTGRES_14. See [the complete list](https://cloud.google.com/sql/docs/mysql/admin-api/rest/v1/SqlDatabaseVersion). }, "description": "A String", # Contains more details about the finding. + "discoveredWorkload": { # Represents discovered, customer managed workload that is not registered with the respective GCP service. # DiscoveredWorkload associated with the finding. + "confidence": "A String", # The confidence in detection of this workload. + "detectedRelevantHardware": True or False, # A boolean flag set to true if associated hardware strongly predicts the workload type. + "detectedRelevantKeywords": True or False, # A boolean flag set to true if associated keywords strongly predict the workload type. + "detectedRelevantPackages": True or False, # A boolean flag set to true if installed packages strongly predict the workload type. + "workloadType": "A String", # The type of workload. + }, "disk": { # Contains information about the disk associated with the finding. # Disk associated with the finding. "name": "A String", # The name of the disk, for example, "https://www.googleapis.com/compute/v1/projects/{project-id}/zones/{zone-id}/disks/{disk-id}". }, diff --git a/docs/dyn/securitycenter_v1.projects.sources.findings.html b/docs/dyn/securitycenter_v1.projects.sources.findings.html index 9a0490fa66..7abe9782b1 100644 --- a/docs/dyn/securitycenter_v1.projects.sources.findings.html +++ b/docs/dyn/securitycenter_v1.projects.sources.findings.html @@ -431,6 +431,13 @@

Method Details

"version": "A String", # The version of the database, for example, POSTGRES_14. See [the complete list](https://cloud.google.com/sql/docs/mysql/admin-api/rest/v1/SqlDatabaseVersion). }, "description": "A String", # Contains more details about the finding. + "discoveredWorkload": { # Represents discovered, customer managed workload that is not registered with the respective GCP service. # DiscoveredWorkload associated with the finding. + "confidence": "A String", # The confidence in detection of this workload. + "detectedRelevantHardware": True or False, # A boolean flag set to true if associated hardware strongly predicts the workload type. + "detectedRelevantKeywords": True or False, # A boolean flag set to true if associated keywords strongly predict the workload type. + "detectedRelevantPackages": True or False, # A boolean flag set to true if installed packages strongly predict the workload type. + "workloadType": "A String", # The type of workload. + }, "disk": { # Contains information about the disk associated with the finding. # Disk associated with the finding. "name": "A String", # The name of the disk, for example, "https://www.googleapis.com/compute/v1/projects/{project-id}/zones/{zone-id}/disks/{disk-id}". }, @@ -1373,6 +1380,13 @@

Method Details

"version": "A String", # The version of the database, for example, POSTGRES_14. See [the complete list](https://cloud.google.com/sql/docs/mysql/admin-api/rest/v1/SqlDatabaseVersion). }, "description": "A String", # Contains more details about the finding. + "discoveredWorkload": { # Represents discovered, customer managed workload that is not registered with the respective GCP service. # DiscoveredWorkload associated with the finding. + "confidence": "A String", # The confidence in detection of this workload. + "detectedRelevantHardware": True or False, # A boolean flag set to true if associated hardware strongly predicts the workload type. + "detectedRelevantKeywords": True or False, # A boolean flag set to true if associated keywords strongly predict the workload type. + "detectedRelevantPackages": True or False, # A boolean flag set to true if installed packages strongly predict the workload type. + "workloadType": "A String", # The type of workload. + }, "disk": { # Contains information about the disk associated with the finding. # Disk associated with the finding. "name": "A String", # The name of the disk, for example, "https://www.googleapis.com/compute/v1/projects/{project-id}/zones/{zone-id}/disks/{disk-id}". }, @@ -2171,6 +2185,13 @@

Method Details

"version": "A String", # The version of the database, for example, POSTGRES_14. See [the complete list](https://cloud.google.com/sql/docs/mysql/admin-api/rest/v1/SqlDatabaseVersion). }, "description": "A String", # Contains more details about the finding. + "discoveredWorkload": { # Represents discovered, customer managed workload that is not registered with the respective GCP service. # DiscoveredWorkload associated with the finding. + "confidence": "A String", # The confidence in detection of this workload. + "detectedRelevantHardware": True or False, # A boolean flag set to true if associated hardware strongly predicts the workload type. + "detectedRelevantKeywords": True or False, # A boolean flag set to true if associated keywords strongly predict the workload type. + "detectedRelevantPackages": True or False, # A boolean flag set to true if installed packages strongly predict the workload type. + "workloadType": "A String", # The type of workload. + }, "disk": { # Contains information about the disk associated with the finding. # Disk associated with the finding. "name": "A String", # The name of the disk, for example, "https://www.googleapis.com/compute/v1/projects/{project-id}/zones/{zone-id}/disks/{disk-id}". }, @@ -2982,6 +3003,13 @@

Method Details

"version": "A String", # The version of the database, for example, POSTGRES_14. See [the complete list](https://cloud.google.com/sql/docs/mysql/admin-api/rest/v1/SqlDatabaseVersion). }, "description": "A String", # Contains more details about the finding. + "discoveredWorkload": { # Represents discovered, customer managed workload that is not registered with the respective GCP service. # DiscoveredWorkload associated with the finding. + "confidence": "A String", # The confidence in detection of this workload. + "detectedRelevantHardware": True or False, # A boolean flag set to true if associated hardware strongly predicts the workload type. + "detectedRelevantKeywords": True or False, # A boolean flag set to true if associated keywords strongly predict the workload type. + "detectedRelevantPackages": True or False, # A boolean flag set to true if installed packages strongly predict the workload type. + "workloadType": "A String", # The type of workload. + }, "disk": { # Contains information about the disk associated with the finding. # Disk associated with the finding. "name": "A String", # The name of the disk, for example, "https://www.googleapis.com/compute/v1/projects/{project-id}/zones/{zone-id}/disks/{disk-id}". }, @@ -3794,6 +3822,13 @@

Method Details

"version": "A String", # The version of the database, for example, POSTGRES_14. See [the complete list](https://cloud.google.com/sql/docs/mysql/admin-api/rest/v1/SqlDatabaseVersion). }, "description": "A String", # Contains more details about the finding. + "discoveredWorkload": { # Represents discovered, customer managed workload that is not registered with the respective GCP service. # DiscoveredWorkload associated with the finding. + "confidence": "A String", # The confidence in detection of this workload. + "detectedRelevantHardware": True or False, # A boolean flag set to true if associated hardware strongly predicts the workload type. + "detectedRelevantKeywords": True or False, # A boolean flag set to true if associated keywords strongly predict the workload type. + "detectedRelevantPackages": True or False, # A boolean flag set to true if installed packages strongly predict the workload type. + "workloadType": "A String", # The type of workload. + }, "disk": { # Contains information about the disk associated with the finding. # Disk associated with the finding. "name": "A String", # The name of the disk, for example, "https://www.googleapis.com/compute/v1/projects/{project-id}/zones/{zone-id}/disks/{disk-id}". }, diff --git a/docs/dyn/storagebatchoperations_v1.projects.locations.html b/docs/dyn/storagebatchoperations_v1.projects.locations.html index c968f95313..747d986283 100644 --- a/docs/dyn/storagebatchoperations_v1.projects.locations.html +++ b/docs/dyn/storagebatchoperations_v1.projects.locations.html @@ -92,7 +92,7 @@

Instance Methods

Gets information about a location.

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

-

Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.

+

Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.

list_next()

Retrieves the next page of results.

@@ -131,7 +131,7 @@

Method Details

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
+  
Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
diff --git a/docs/dyn/storagebatchoperations_v1.projects.locations.jobs.bucketOperations.html b/docs/dyn/storagebatchoperations_v1.projects.locations.jobs.bucketOperations.html
index f82c557ed0..49039c0fe8 100644
--- a/docs/dyn/storagebatchoperations_v1.projects.locations.jobs.bucketOperations.html
+++ b/docs/dyn/storagebatchoperations_v1.projects.locations.jobs.bucketOperations.html
@@ -110,7 +110,10 @@ 

Method Details

"bucketName": "A String", # The bucket name of the objects to be transformed in the BucketOperation. "completeTime": "A String", # Output only. The time that the BucketOperation was completed. "counters": { # Describes details about the progress of the job. # Output only. Information about the progress of the bucket operation. - "failedObjectCount": "A String", # Output only. Number of objects failed. + "failedObjectCount": "A String", # Output only. The number of objects that failed due to user errors or service errors. + "objectCustomContextsCreated": "A String", # Output only. Number of object custom contexts created. This field is only populated for jobs with the UpdateObjectCustomContext transformation. + "objectCustomContextsDeleted": "A String", # Output only. Number of object custom contexts deleted. This field is only populated for jobs with the UpdateObjectCustomContext transformation. + "objectCustomContextsUpdated": "A String", # Output only. Number of object custom contexts updated. This counter tracks custom contexts where the key already existed, but the payload was modified. This field is only populated for jobs with the UpdateObjectCustomContext transformation. "succeededObjectCount": "A String", # Output only. Number of objects completed. "totalBytesFound": "A String", # Output only. Number of bytes found from source. This field is only populated for jobs with a prefix list object configuration. "totalObjectCount": "A String", # Output only. Number of objects listed. @@ -206,7 +209,10 @@

Method Details

"bucketName": "A String", # The bucket name of the objects to be transformed in the BucketOperation. "completeTime": "A String", # Output only. The time that the BucketOperation was completed. "counters": { # Describes details about the progress of the job. # Output only. Information about the progress of the bucket operation. - "failedObjectCount": "A String", # Output only. Number of objects failed. + "failedObjectCount": "A String", # Output only. The number of objects that failed due to user errors or service errors. + "objectCustomContextsCreated": "A String", # Output only. Number of object custom contexts created. This field is only populated for jobs with the UpdateObjectCustomContext transformation. + "objectCustomContextsDeleted": "A String", # Output only. Number of object custom contexts deleted. This field is only populated for jobs with the UpdateObjectCustomContext transformation. + "objectCustomContextsUpdated": "A String", # Output only. Number of object custom contexts updated. This counter tracks custom contexts where the key already existed, but the payload was modified. This field is only populated for jobs with the UpdateObjectCustomContext transformation. "succeededObjectCount": "A String", # Output only. Number of objects completed. "totalBytesFound": "A String", # Output only. Number of bytes found from source. This field is only populated for jobs with a prefix list object configuration. "totalObjectCount": "A String", # Output only. Number of objects listed. diff --git a/docs/dyn/storagebatchoperations_v1.projects.locations.jobs.html b/docs/dyn/storagebatchoperations_v1.projects.locations.jobs.html index 3d139ec46b..afe84b18ae 100644 --- a/docs/dyn/storagebatchoperations_v1.projects.locations.jobs.html +++ b/docs/dyn/storagebatchoperations_v1.projects.locations.jobs.html @@ -158,7 +158,10 @@

Method Details

}, "completeTime": "A String", # Output only. The time that the job was completed. "counters": { # Describes details about the progress of the job. # Output only. Information about the progress of the job. - "failedObjectCount": "A String", # Output only. Number of objects failed. + "failedObjectCount": "A String", # Output only. The number of objects that failed due to user errors or service errors. + "objectCustomContextsCreated": "A String", # Output only. Number of object custom contexts created. This field is only populated for jobs with the UpdateObjectCustomContext transformation. + "objectCustomContextsDeleted": "A String", # Output only. Number of object custom contexts deleted. This field is only populated for jobs with the UpdateObjectCustomContext transformation. + "objectCustomContextsUpdated": "A String", # Output only. Number of object custom contexts updated. This counter tracks custom contexts where the key already existed, but the payload was modified. This field is only populated for jobs with the UpdateObjectCustomContext transformation. "succeededObjectCount": "A String", # Output only. Number of objects completed. "totalBytesFound": "A String", # Output only. Number of bytes found from source. This field is only populated for jobs with a prefix list object configuration. "totalObjectCount": "A String", # Output only. Number of objects listed. @@ -315,7 +318,10 @@

Method Details

}, "completeTime": "A String", # Output only. The time that the job was completed. "counters": { # Describes details about the progress of the job. # Output only. Information about the progress of the job. - "failedObjectCount": "A String", # Output only. Number of objects failed. + "failedObjectCount": "A String", # Output only. The number of objects that failed due to user errors or service errors. + "objectCustomContextsCreated": "A String", # Output only. Number of object custom contexts created. This field is only populated for jobs with the UpdateObjectCustomContext transformation. + "objectCustomContextsDeleted": "A String", # Output only. Number of object custom contexts deleted. This field is only populated for jobs with the UpdateObjectCustomContext transformation. + "objectCustomContextsUpdated": "A String", # Output only. Number of object custom contexts updated. This counter tracks custom contexts where the key already existed, but the payload was modified. This field is only populated for jobs with the UpdateObjectCustomContext transformation. "succeededObjectCount": "A String", # Output only. Number of objects completed. "totalBytesFound": "A String", # Output only. Number of bytes found from source. This field is only populated for jobs with a prefix list object configuration. "totalObjectCount": "A String", # Output only. Number of objects listed. @@ -428,7 +434,10 @@

Method Details

}, "completeTime": "A String", # Output only. The time that the job was completed. "counters": { # Describes details about the progress of the job. # Output only. Information about the progress of the job. - "failedObjectCount": "A String", # Output only. Number of objects failed. + "failedObjectCount": "A String", # Output only. The number of objects that failed due to user errors or service errors. + "objectCustomContextsCreated": "A String", # Output only. Number of object custom contexts created. This field is only populated for jobs with the UpdateObjectCustomContext transformation. + "objectCustomContextsDeleted": "A String", # Output only. Number of object custom contexts deleted. This field is only populated for jobs with the UpdateObjectCustomContext transformation. + "objectCustomContextsUpdated": "A String", # Output only. Number of object custom contexts updated. This counter tracks custom contexts where the key already existed, but the payload was modified. This field is only populated for jobs with the UpdateObjectCustomContext transformation. "succeededObjectCount": "A String", # Output only. Number of objects completed. "totalBytesFound": "A String", # Output only. Number of bytes found from source. This field is only populated for jobs with a prefix list object configuration. "totalObjectCount": "A String", # Output only. Number of objects listed. diff --git a/docs/dyn/workflows_v1.projects.locations.html b/docs/dyn/workflows_v1.projects.locations.html index d3ef95539b..b5f13e95fe 100644 --- a/docs/dyn/workflows_v1.projects.locations.html +++ b/docs/dyn/workflows_v1.projects.locations.html @@ -92,7 +92,7 @@

Instance Methods

Gets information about a location.

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

-

Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.

+

Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.

list_next()

Retrieves the next page of results.

@@ -131,7 +131,7 @@

Method Details

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
+  
Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
diff --git a/docs/dyn/workflows_v1beta.projects.locations.html b/docs/dyn/workflows_v1beta.projects.locations.html
index 39c381190b..2d6d570287 100644
--- a/docs/dyn/workflows_v1beta.projects.locations.html
+++ b/docs/dyn/workflows_v1beta.projects.locations.html
@@ -92,7 +92,7 @@ 

Instance Methods

Gets information about a location.

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

-

Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.

+

Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.

list_next()

Retrieves the next page of results.

@@ -131,7 +131,7 @@

Method Details

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
+  
Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
diff --git a/docs/dyn/workspaceevents_v1.subscriptions.html b/docs/dyn/workspaceevents_v1.subscriptions.html
index 7e5487dddf..f017531b36 100644
--- a/docs/dyn/workspaceevents_v1.subscriptions.html
+++ b/docs/dyn/workspaceevents_v1.subscriptions.html
@@ -129,12 +129,14 @@ 

Method Details

"includeResource": True or False, # Optional. Whether the event payload includes data about the resource that changed. For example, for an event where a Google Chat message was created, whether the payload contains data about the [`Message`](https://developers.google.com/chat/api/reference/rest/v1/spaces.messages) resource. If false, the event payload only includes the name of the changed resource. }, "reconciling": True or False, # Output only. If `true`, the subscription is in the process of being updated. + "serviceAccountAuthority": "A String", # Output only. The service account that was used to authorize the creation of the subscription. This service account must be owned by the same Google Cloud project where you create this subscription. Format: `projects/{project_id}/serviceAccounts/{service_account_id}` [Developer Preview](https://developers.google.com/workspace/preview). "state": "A String", # Output only. The state of the subscription. Determines whether the subscription can receive events and deliver them to the notification endpoint. "suspensionReason": "A String", # Output only. The error that suspended the subscription. To reactivate the subscription, resolve the error and call the `ReactivateSubscription` method. "targetResource": "A String", # Required. Immutable. The Google Workspace resource that's monitored for events, formatted as the [full resource name](https://google.aip.dev/122#full-resource-names). To learn about target resources and the events that they support, see [Supported Google Workspace events](https://developers.google.com/workspace/events#supported-events). A user can only authorize your app to create one subscription for a given target resource. If your app tries to create another subscription with the same user credentials, the request returns an `ALREADY_EXISTS` error. "ttl": "A String", # Input only. The time-to-live (TTL) or duration for the subscription. If unspecified or set to `0`, uses the maximum possible duration. "uid": "A String", # Output only. System-assigned unique identifier for the subscription. "updateTime": "A String", # Output only. The last time that the subscription is updated. + "userAuthority": "A String", # Output only. The user who authorized the creation of the subscription. The user must be able to view the `target_resource`. For Google Workspace users, the `{user}` value is the [`user.id`](https://developers.google.com/workspace/admin/directory/reference/rest/v1/users#User.FIELDS.id) field from the Directory API. Format: `users/{user}` [Developer Preview](https://developers.google.com/workspace/preview). } validateOnly: boolean, Optional. If set to `true`, validates and previews the request, but doesn't create the subscription. @@ -236,12 +238,14 @@

Method Details

"includeResource": True or False, # Optional. Whether the event payload includes data about the resource that changed. For example, for an event where a Google Chat message was created, whether the payload contains data about the [`Message`](https://developers.google.com/chat/api/reference/rest/v1/spaces.messages) resource. If false, the event payload only includes the name of the changed resource. }, "reconciling": True or False, # Output only. If `true`, the subscription is in the process of being updated. + "serviceAccountAuthority": "A String", # Output only. The service account that was used to authorize the creation of the subscription. This service account must be owned by the same Google Cloud project where you create this subscription. Format: `projects/{project_id}/serviceAccounts/{service_account_id}` [Developer Preview](https://developers.google.com/workspace/preview). "state": "A String", # Output only. The state of the subscription. Determines whether the subscription can receive events and deliver them to the notification endpoint. "suspensionReason": "A String", # Output only. The error that suspended the subscription. To reactivate the subscription, resolve the error and call the `ReactivateSubscription` method. "targetResource": "A String", # Required. Immutable. The Google Workspace resource that's monitored for events, formatted as the [full resource name](https://google.aip.dev/122#full-resource-names). To learn about target resources and the events that they support, see [Supported Google Workspace events](https://developers.google.com/workspace/events#supported-events). A user can only authorize your app to create one subscription for a given target resource. If your app tries to create another subscription with the same user credentials, the request returns an `ALREADY_EXISTS` error. "ttl": "A String", # Input only. The time-to-live (TTL) or duration for the subscription. If unspecified or set to `0`, uses the maximum possible duration. "uid": "A String", # Output only. System-assigned unique identifier for the subscription. "updateTime": "A String", # Output only. The last time that the subscription is updated. + "userAuthority": "A String", # Output only. The user who authorized the creation of the subscription. The user must be able to view the `target_resource`. For Google Workspace users, the `{user}` value is the [`user.id`](https://developers.google.com/workspace/admin/directory/reference/rest/v1/users#User.FIELDS.id) field from the Directory API. Format: `users/{user}` [Developer Preview](https://developers.google.com/workspace/preview). }
@@ -281,12 +285,14 @@

Method Details

"includeResource": True or False, # Optional. Whether the event payload includes data about the resource that changed. For example, for an event where a Google Chat message was created, whether the payload contains data about the [`Message`](https://developers.google.com/chat/api/reference/rest/v1/spaces.messages) resource. If false, the event payload only includes the name of the changed resource. }, "reconciling": True or False, # Output only. If `true`, the subscription is in the process of being updated. + "serviceAccountAuthority": "A String", # Output only. The service account that was used to authorize the creation of the subscription. This service account must be owned by the same Google Cloud project where you create this subscription. Format: `projects/{project_id}/serviceAccounts/{service_account_id}` [Developer Preview](https://developers.google.com/workspace/preview). "state": "A String", # Output only. The state of the subscription. Determines whether the subscription can receive events and deliver them to the notification endpoint. "suspensionReason": "A String", # Output only. The error that suspended the subscription. To reactivate the subscription, resolve the error and call the `ReactivateSubscription` method. "targetResource": "A String", # Required. Immutable. The Google Workspace resource that's monitored for events, formatted as the [full resource name](https://google.aip.dev/122#full-resource-names). To learn about target resources and the events that they support, see [Supported Google Workspace events](https://developers.google.com/workspace/events#supported-events). A user can only authorize your app to create one subscription for a given target resource. If your app tries to create another subscription with the same user credentials, the request returns an `ALREADY_EXISTS` error. "ttl": "A String", # Input only. The time-to-live (TTL) or duration for the subscription. If unspecified or set to `0`, uses the maximum possible duration. "uid": "A String", # Output only. System-assigned unique identifier for the subscription. "updateTime": "A String", # Output only. The last time that the subscription is updated. + "userAuthority": "A String", # Output only. The user who authorized the creation of the subscription. The user must be able to view the `target_resource`. For Google Workspace users, the `{user}` value is the [`user.id`](https://developers.google.com/workspace/admin/directory/reference/rest/v1/users#User.FIELDS.id) field from the Directory API. Format: `users/{user}` [Developer Preview](https://developers.google.com/workspace/preview). }, ], }
@@ -332,12 +338,14 @@

Method Details

"includeResource": True or False, # Optional. Whether the event payload includes data about the resource that changed. For example, for an event where a Google Chat message was created, whether the payload contains data about the [`Message`](https://developers.google.com/chat/api/reference/rest/v1/spaces.messages) resource. If false, the event payload only includes the name of the changed resource. }, "reconciling": True or False, # Output only. If `true`, the subscription is in the process of being updated. + "serviceAccountAuthority": "A String", # Output only. The service account that was used to authorize the creation of the subscription. This service account must be owned by the same Google Cloud project where you create this subscription. Format: `projects/{project_id}/serviceAccounts/{service_account_id}` [Developer Preview](https://developers.google.com/workspace/preview). "state": "A String", # Output only. The state of the subscription. Determines whether the subscription can receive events and deliver them to the notification endpoint. "suspensionReason": "A String", # Output only. The error that suspended the subscription. To reactivate the subscription, resolve the error and call the `ReactivateSubscription` method. "targetResource": "A String", # Required. Immutable. The Google Workspace resource that's monitored for events, formatted as the [full resource name](https://google.aip.dev/122#full-resource-names). To learn about target resources and the events that they support, see [Supported Google Workspace events](https://developers.google.com/workspace/events#supported-events). A user can only authorize your app to create one subscription for a given target resource. If your app tries to create another subscription with the same user credentials, the request returns an `ALREADY_EXISTS` error. "ttl": "A String", # Input only. The time-to-live (TTL) or duration for the subscription. If unspecified or set to `0`, uses the maximum possible duration. "uid": "A String", # Output only. System-assigned unique identifier for the subscription. "updateTime": "A String", # Output only. The last time that the subscription is updated. + "userAuthority": "A String", # Output only. The user who authorized the creation of the subscription. The user must be able to view the `target_resource`. For Google Workspace users, the `{user}` value is the [`user.id`](https://developers.google.com/workspace/admin/directory/reference/rest/v1/users#User.FIELDS.id) field from the Directory API. Format: `users/{user}` [Developer Preview](https://developers.google.com/workspace/preview). } updateMask: string, Optional. The field to update. If omitted, updates any fields included in the request. You can update one of the following fields in a subscription: * `expire_time`: The timestamp when the subscription expires. * `ttl`: The time-to-live (TTL) or duration of the subscription. * `event_types`: The list of event types to receive about the target resource. When using the `*` wildcard (equivalent to `PUT`), omitted fields are set to empty values and rejected if they're invalid. diff --git a/docs/dyn/workstations_v1.projects.locations.html b/docs/dyn/workstations_v1.projects.locations.html index d33562c2d5..3ab81a7d00 100644 --- a/docs/dyn/workstations_v1.projects.locations.html +++ b/docs/dyn/workstations_v1.projects.locations.html @@ -92,7 +92,7 @@

Instance Methods

Gets information about a location.

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

-

Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.

+

Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.

list_next()

Retrieves the next page of results.

@@ -131,7 +131,7 @@

Method Details

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
+  
Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
diff --git a/docs/dyn/workstations_v1.projects.locations.workstationClusters.html b/docs/dyn/workstations_v1.projects.locations.workstationClusters.html
index 02bb2ad188..0d8b02b1f0 100644
--- a/docs/dyn/workstations_v1.projects.locations.workstationClusters.html
+++ b/docs/dyn/workstations_v1.projects.locations.workstationClusters.html
@@ -164,7 +164,7 @@ 

Method Details

"updateTime": "A String", # Output only. Time when this workstation cluster was most recently updated. } - validateOnly: boolean, Optional. If set, validate the request and preview the review, but do not actually apply it. + validateOnly: boolean, Optional. If set, validate the request and preview the result, but do not actually apply it. workstationClusterId: string, Required. ID to use for the workstation cluster. x__xgafv: string, V1 error format. Allowed values @@ -203,7 +203,7 @@

Method Details

name: string, Required. Name of the workstation cluster to delete. (required) etag: string, Optional. If set, the request will be rejected if the latest version of the workstation cluster on the server does not have this ETag. force: boolean, Optional. If set, any workstation configurations and workstations in the workstation cluster are also deleted. Otherwise, the request only works if the workstation cluster has no configurations or workstations. - validateOnly: boolean, Optional. If set, validate the request and preview the review, but do not apply it. + validateOnly: boolean, Optional. If set, validate the request and preview the result, but do not apply it. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -446,7 +446,7 @@

Method Details

allowMissing: boolean, Optional. If set, and the workstation cluster is not found, a new workstation cluster will be created. In this situation, update_mask is ignored. updateMask: string, Required. Mask that specifies which fields in the workstation cluster should be updated. - validateOnly: boolean, Optional. If set, validate the request and preview the review, but do not actually apply it. + validateOnly: boolean, Optional. If set, validate the request and preview the result, but do not actually apply it. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/workstations_v1.projects.locations.workstationClusters.workstationConfigs.html b/docs/dyn/workstations_v1.projects.locations.workstationClusters.workstationConfigs.html index 6c836c2899..e0b9a90813 100644 --- a/docs/dyn/workstations_v1.projects.locations.workstationClusters.workstationConfigs.html +++ b/docs/dyn/workstations_v1.projects.locations.workstationClusters.workstationConfigs.html @@ -276,12 +276,12 @@

Method Details

"replicaZones": [ # Optional. Immutable. Specifies the zones used to replicate the VM and disk resources within the region. If set, exactly two zones within the workstation cluster's region must be specified—for example, `['us-central1-a', 'us-central1-f']`. If this field is empty, two default zones within the region are used. Immutable after the workstation configuration is created. "A String", ], - "runningTimeout": "A String", # Optional. Number of seconds that a workstation can run until it is automatically shut down. We recommend that workstations be shut down daily to reduce costs and so that security updates can be applied upon restart. The idle_timeout and running_timeout fields are independent of each other. Note that the running_timeout field shuts down VMs after the specified time, regardless of whether or not the VMs are idle. Provide duration terminated by `s` for seconds—for example, `"54000s"` (15 hours). Defaults to `"43200s"` (12 hours). A value of `"0s"` indicates that workstations using this configuration should never time out. If encryption_key is set, it must be greater than `"0s"` and less than `"86400s"` (24 hours). Warning: A value of `"0s"` indicates that Cloud Workstations VMs created with this configuration have no maximum running time. This is strongly discouraged because you incur costs and will not pick up security updates. + "runningTimeout": "A String", # Optional. Number of seconds that a workstation can run until it is automatically shut down. This field applies to workstations in both STATE_RUNNING and STATE_SUSPENDED. We recommend that workstations be shut down daily to reduce costs and so that security updates can be applied upon restart. The idle_timeout and running_timeout fields are independent of each other. Note that the running_timeout field shuts down VMs after the specified time, regardless of whether or not the VMs are idle. Provide duration terminated by `s` for seconds—for example, `"54000s"` (15 hours). Defaults to `"43200s"` (12 hours). A value of `"0s"` indicates that workstations using this configuration should never time out. If encryption_key is set, it must be greater than `"0s"` and less than `"86400s"` (24 hours). Warning: A value of `"0s"` indicates that Cloud Workstations VMs created with this configuration have no maximum running time. This is strongly discouraged because you incur costs and will not pick up security updates. "uid": "A String", # Output only. A system-assigned unique identifier for this workstation configuration. "updateTime": "A String", # Output only. Time when this workstation configuration was most recently updated. } - validateOnly: boolean, Optional. If set, validate the request and preview the review, but do not actually apply it. + validateOnly: boolean, Optional. If set, validate the request and preview the result, but do not actually apply it. workstationConfigId: string, Required. ID to use for the workstation configuration. x__xgafv: string, V1 error format. Allowed values @@ -320,7 +320,7 @@

Method Details

name: string, Required. Name of the workstation configuration to delete. (required) etag: string, Optional. If set, the request is rejected if the latest version of the workstation configuration on the server does not have this ETag. force: boolean, Optional. If set, any workstations in the workstation configuration are also deleted. Otherwise, the request works only if the workstation configuration has no workstations. - validateOnly: boolean, Optional. If set, validate the request and preview the review, but do not actually apply it. + validateOnly: boolean, Optional. If set, validate the request and preview the result, but do not actually apply it. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -510,7 +510,7 @@

Method Details

"replicaZones": [ # Optional. Immutable. Specifies the zones used to replicate the VM and disk resources within the region. If set, exactly two zones within the workstation cluster's region must be specified—for example, `['us-central1-a', 'us-central1-f']`. If this field is empty, two default zones within the region are used. Immutable after the workstation configuration is created. "A String", ], - "runningTimeout": "A String", # Optional. Number of seconds that a workstation can run until it is automatically shut down. We recommend that workstations be shut down daily to reduce costs and so that security updates can be applied upon restart. The idle_timeout and running_timeout fields are independent of each other. Note that the running_timeout field shuts down VMs after the specified time, regardless of whether or not the VMs are idle. Provide duration terminated by `s` for seconds—for example, `"54000s"` (15 hours). Defaults to `"43200s"` (12 hours). A value of `"0s"` indicates that workstations using this configuration should never time out. If encryption_key is set, it must be greater than `"0s"` and less than `"86400s"` (24 hours). Warning: A value of `"0s"` indicates that Cloud Workstations VMs created with this configuration have no maximum running time. This is strongly discouraged because you incur costs and will not pick up security updates. + "runningTimeout": "A String", # Optional. Number of seconds that a workstation can run until it is automatically shut down. This field applies to workstations in both STATE_RUNNING and STATE_SUSPENDED. We recommend that workstations be shut down daily to reduce costs and so that security updates can be applied upon restart. The idle_timeout and running_timeout fields are independent of each other. Note that the running_timeout field shuts down VMs after the specified time, regardless of whether or not the VMs are idle. Provide duration terminated by `s` for seconds—for example, `"54000s"` (15 hours). Defaults to `"43200s"` (12 hours). A value of `"0s"` indicates that workstations using this configuration should never time out. If encryption_key is set, it must be greater than `"0s"` and less than `"86400s"` (24 hours). Warning: A value of `"0s"` indicates that Cloud Workstations VMs created with this configuration have no maximum running time. This is strongly discouraged because you incur costs and will not pick up security updates. "uid": "A String", # Output only. A system-assigned unique identifier for this workstation configuration. "updateTime": "A String", # Output only. Time when this workstation configuration was most recently updated. }
@@ -733,7 +733,7 @@

Method Details

"replicaZones": [ # Optional. Immutable. Specifies the zones used to replicate the VM and disk resources within the region. If set, exactly two zones within the workstation cluster's region must be specified—for example, `['us-central1-a', 'us-central1-f']`. If this field is empty, two default zones within the region are used. Immutable after the workstation configuration is created. "A String", ], - "runningTimeout": "A String", # Optional. Number of seconds that a workstation can run until it is automatically shut down. We recommend that workstations be shut down daily to reduce costs and so that security updates can be applied upon restart. The idle_timeout and running_timeout fields are independent of each other. Note that the running_timeout field shuts down VMs after the specified time, regardless of whether or not the VMs are idle. Provide duration terminated by `s` for seconds—for example, `"54000s"` (15 hours). Defaults to `"43200s"` (12 hours). A value of `"0s"` indicates that workstations using this configuration should never time out. If encryption_key is set, it must be greater than `"0s"` and less than `"86400s"` (24 hours). Warning: A value of `"0s"` indicates that Cloud Workstations VMs created with this configuration have no maximum running time. This is strongly discouraged because you incur costs and will not pick up security updates. + "runningTimeout": "A String", # Optional. Number of seconds that a workstation can run until it is automatically shut down. This field applies to workstations in both STATE_RUNNING and STATE_SUSPENDED. We recommend that workstations be shut down daily to reduce costs and so that security updates can be applied upon restart. The idle_timeout and running_timeout fields are independent of each other. Note that the running_timeout field shuts down VMs after the specified time, regardless of whether or not the VMs are idle. Provide duration terminated by `s` for seconds—for example, `"54000s"` (15 hours). Defaults to `"43200s"` (12 hours). A value of `"0s"` indicates that workstations using this configuration should never time out. If encryption_key is set, it must be greater than `"0s"` and less than `"86400s"` (24 hours). Warning: A value of `"0s"` indicates that Cloud Workstations VMs created with this configuration have no maximum running time. This is strongly discouraged because you incur costs and will not pick up security updates. "uid": "A String", # Output only. A system-assigned unique identifier for this workstation configuration. "updateTime": "A String", # Output only. Time when this workstation configuration was most recently updated. }, @@ -909,7 +909,7 @@

Method Details

"replicaZones": [ # Optional. Immutable. Specifies the zones used to replicate the VM and disk resources within the region. If set, exactly two zones within the workstation cluster's region must be specified—for example, `['us-central1-a', 'us-central1-f']`. If this field is empty, two default zones within the region are used. Immutable after the workstation configuration is created. "A String", ], - "runningTimeout": "A String", # Optional. Number of seconds that a workstation can run until it is automatically shut down. We recommend that workstations be shut down daily to reduce costs and so that security updates can be applied upon restart. The idle_timeout and running_timeout fields are independent of each other. Note that the running_timeout field shuts down VMs after the specified time, regardless of whether or not the VMs are idle. Provide duration terminated by `s` for seconds—for example, `"54000s"` (15 hours). Defaults to `"43200s"` (12 hours). A value of `"0s"` indicates that workstations using this configuration should never time out. If encryption_key is set, it must be greater than `"0s"` and less than `"86400s"` (24 hours). Warning: A value of `"0s"` indicates that Cloud Workstations VMs created with this configuration have no maximum running time. This is strongly discouraged because you incur costs and will not pick up security updates. + "runningTimeout": "A String", # Optional. Number of seconds that a workstation can run until it is automatically shut down. This field applies to workstations in both STATE_RUNNING and STATE_SUSPENDED. We recommend that workstations be shut down daily to reduce costs and so that security updates can be applied upon restart. The idle_timeout and running_timeout fields are independent of each other. Note that the running_timeout field shuts down VMs after the specified time, regardless of whether or not the VMs are idle. Provide duration terminated by `s` for seconds—for example, `"54000s"` (15 hours). Defaults to `"43200s"` (12 hours). A value of `"0s"` indicates that workstations using this configuration should never time out. If encryption_key is set, it must be greater than `"0s"` and less than `"86400s"` (24 hours). Warning: A value of `"0s"` indicates that Cloud Workstations VMs created with this configuration have no maximum running time. This is strongly discouraged because you incur costs and will not pick up security updates. "uid": "A String", # Output only. A system-assigned unique identifier for this workstation configuration. "updateTime": "A String", # Output only. Time when this workstation configuration was most recently updated. }, @@ -1100,14 +1100,14 @@

Method Details

"replicaZones": [ # Optional. Immutable. Specifies the zones used to replicate the VM and disk resources within the region. If set, exactly two zones within the workstation cluster's region must be specified—for example, `['us-central1-a', 'us-central1-f']`. If this field is empty, two default zones within the region are used. Immutable after the workstation configuration is created. "A String", ], - "runningTimeout": "A String", # Optional. Number of seconds that a workstation can run until it is automatically shut down. We recommend that workstations be shut down daily to reduce costs and so that security updates can be applied upon restart. The idle_timeout and running_timeout fields are independent of each other. Note that the running_timeout field shuts down VMs after the specified time, regardless of whether or not the VMs are idle. Provide duration terminated by `s` for seconds—for example, `"54000s"` (15 hours). Defaults to `"43200s"` (12 hours). A value of `"0s"` indicates that workstations using this configuration should never time out. If encryption_key is set, it must be greater than `"0s"` and less than `"86400s"` (24 hours). Warning: A value of `"0s"` indicates that Cloud Workstations VMs created with this configuration have no maximum running time. This is strongly discouraged because you incur costs and will not pick up security updates. + "runningTimeout": "A String", # Optional. Number of seconds that a workstation can run until it is automatically shut down. This field applies to workstations in both STATE_RUNNING and STATE_SUSPENDED. We recommend that workstations be shut down daily to reduce costs and so that security updates can be applied upon restart. The idle_timeout and running_timeout fields are independent of each other. Note that the running_timeout field shuts down VMs after the specified time, regardless of whether or not the VMs are idle. Provide duration terminated by `s` for seconds—for example, `"54000s"` (15 hours). Defaults to `"43200s"` (12 hours). A value of `"0s"` indicates that workstations using this configuration should never time out. If encryption_key is set, it must be greater than `"0s"` and less than `"86400s"` (24 hours). Warning: A value of `"0s"` indicates that Cloud Workstations VMs created with this configuration have no maximum running time. This is strongly discouraged because you incur costs and will not pick up security updates. "uid": "A String", # Output only. A system-assigned unique identifier for this workstation configuration. "updateTime": "A String", # Output only. Time when this workstation configuration was most recently updated. } allowMissing: boolean, Optional. If set and the workstation configuration is not found, a new workstation configuration will be created. In this situation, update_mask is ignored. updateMask: string, Required. Mask specifying which fields in the workstation configuration should be updated. - validateOnly: boolean, Optional. If set, validate the request and preview the review, but do not actually apply it. + validateOnly: boolean, Optional. If set, validate the request and preview the result, but do not actually apply it. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/workstations_v1.projects.locations.workstationClusters.workstationConfigs.workstations.html b/docs/dyn/workstations_v1.projects.locations.workstationClusters.workstationConfigs.workstations.html index 76e6f186f1..2cc7615b51 100644 --- a/docs/dyn/workstations_v1.projects.locations.workstationClusters.workstationConfigs.workstations.html +++ b/docs/dyn/workstations_v1.projects.locations.workstationClusters.workstationConfigs.workstations.html @@ -166,7 +166,7 @@

Method Details

"updateTime": "A String", # Output only. Time when this workstation was most recently updated. } - validateOnly: boolean, Optional. If set, validate the request and preview the review, but do not actually apply it. + validateOnly: boolean, Optional. If set, validate the request and preview the result, but do not actually apply it. workstationId: string, Required. ID to use for the workstation. x__xgafv: string, V1 error format. Allowed values @@ -204,7 +204,7 @@

Method Details

Args: name: string, Required. Name of the workstation to delete. (required) etag: string, Optional. If set, the request will be rejected if the latest version of the workstation on the server does not have this ETag. - validateOnly: boolean, Optional. If set, validate the request and preview the review, but do not actually apply it. + validateOnly: boolean, Optional. If set, validate the request and preview the result, but do not actually apply it. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -542,9 +542,9 @@

Method Details

"updateTime": "A String", # Output only. Time when this workstation was most recently updated. } - allowMissing: boolean, Optional. If set and the workstation configuration is not found, a new workstation configuration is created. In this situation, update_mask is ignored. - updateMask: string, Required. Mask specifying which fields in the workstation configuration should be updated. - validateOnly: boolean, Optional. If set, validate the request and preview the review, but do not actually apply it. + allowMissing: boolean, Optional. If set and the workstation is not found, a new workstation is created. In this situation, update_mask is ignored. + updateMask: string, Required. Mask specifying which fields in the workstation should be updated. + validateOnly: boolean, Optional. If set, validate the request and preview the result, but do not actually apply it. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -671,7 +671,7 @@

Method Details

{ # Request message for StartWorkstation. "boostConfig": "A String", # Optional. If set, the workstation starts using the boost configuration with the specified ID. "etag": "A String", # Optional. If set, the request will be rejected if the latest version of the workstation on the server does not have this ETag. - "validateOnly": True or False, # Optional. If set, validate the request and preview the review, but do not actually apply it. + "validateOnly": True or False, # Optional. If set, validate the request and preview the result, but do not actually apply it. } x__xgafv: string, V1 error format. @@ -714,7 +714,7 @@

Method Details

{ # Request message for StopWorkstation. "etag": "A String", # Optional. If set, the request will be rejected if the latest version of the workstation on the server does not have this ETag. - "validateOnly": True or False, # Optional. If set, validate the request and preview the review, but do not actually apply it. + "validateOnly": True or False, # Optional. If set, validate the request and preview the result, but do not actually apply it. } x__xgafv: string, V1 error format. diff --git a/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.html b/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.html index 9538745c5a..77a5902d87 100644 --- a/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.html +++ b/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.html @@ -164,9 +164,11 @@

Method Details

}, "uid": "A String", # Output only. A system-assigned unique identifier for this workstation cluster. "updateTime": "A String", # Output only. Time when this workstation cluster was most recently updated. + "workstationAuthorizationUrl": "A String", # Optional. Specifies the redirect URL for unauthorized requests received by workstation VMs in this cluster. Redirects to this endpoint will send a base64 encoded `state` query param containing the target workstation name and original request hostname. The endpoint is responsible for retrieving a token using `GenerateAccessToken` and redirecting back to the original hostname with the token. + "workstationLaunchUrl": "A String", # Optional. Specifies the launch URL for workstations in this cluster. Requests sent to unstarted workstations will be redirected to this URL. Requests redirected to the launch endpoint will be sent with a `workstation` and `project` query parameter containing the full workstation resource name and project ID, respectively. The launch endpoint is responsible for starting the workstation, polling it until it reaches `STATE_RUNNING`, and then issuing a redirect to the workstation's host URL. } - validateOnly: boolean, Optional. If set, validate the request and preview the review, but do not actually apply it. + validateOnly: boolean, Optional. If set, validate the request and preview the result, but do not actually apply it. workstationClusterId: string, Required. ID to use for the workstation cluster. x__xgafv: string, V1 error format. Allowed values @@ -205,7 +207,7 @@

Method Details

name: string, Required. Name of the workstation cluster to delete. (required) etag: string, Optional. If set, the request will be rejected if the latest version of the workstation cluster on the server does not have this ETag. force: boolean, Optional. If set, any workstation configurations and workstations in the workstation cluster are also deleted. Otherwise, the request only works if the workstation cluster has no configurations or workstations. - validateOnly: boolean, Optional. If set, validate the request and preview the review, but do not apply it. + validateOnly: boolean, Optional. If set, validate the request and preview the result, but do not apply it. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -298,6 +300,8 @@

Method Details

}, "uid": "A String", # Output only. A system-assigned unique identifier for this workstation cluster. "updateTime": "A String", # Output only. Time when this workstation cluster was most recently updated. + "workstationAuthorizationUrl": "A String", # Optional. Specifies the redirect URL for unauthorized requests received by workstation VMs in this cluster. Redirects to this endpoint will send a base64 encoded `state` query param containing the target workstation name and original request hostname. The endpoint is responsible for retrieving a token using `GenerateAccessToken` and redirecting back to the original hostname with the token. + "workstationLaunchUrl": "A String", # Optional. Specifies the launch URL for workstations in this cluster. Requests sent to unstarted workstations will be redirected to this URL. Requests redirected to the launch endpoint will be sent with a `workstation` and `project` query parameter containing the full workstation resource name and project ID, respectively. The launch endpoint is responsible for starting the workstation, polling it until it reaches `STATE_RUNNING`, and then issuing a redirect to the workstation's host URL. }
@@ -373,6 +377,8 @@

Method Details

}, "uid": "A String", # Output only. A system-assigned unique identifier for this workstation cluster. "updateTime": "A String", # Output only. Time when this workstation cluster was most recently updated. + "workstationAuthorizationUrl": "A String", # Optional. Specifies the redirect URL for unauthorized requests received by workstation VMs in this cluster. Redirects to this endpoint will send a base64 encoded `state` query param containing the target workstation name and original request hostname. The endpoint is responsible for retrieving a token using `GenerateAccessToken` and redirecting back to the original hostname with the token. + "workstationLaunchUrl": "A String", # Optional. Specifies the launch URL for workstations in this cluster. Requests sent to unstarted workstations will be redirected to this URL. Requests redirected to the launch endpoint will be sent with a `workstation` and `project` query parameter containing the full workstation resource name and project ID, respectively. The launch endpoint is responsible for starting the workstation, polling it until it reaches `STATE_RUNNING`, and then issuing a redirect to the workstation's host URL. }, ], }
@@ -450,11 +456,13 @@

Method Details

}, "uid": "A String", # Output only. A system-assigned unique identifier for this workstation cluster. "updateTime": "A String", # Output only. Time when this workstation cluster was most recently updated. + "workstationAuthorizationUrl": "A String", # Optional. Specifies the redirect URL for unauthorized requests received by workstation VMs in this cluster. Redirects to this endpoint will send a base64 encoded `state` query param containing the target workstation name and original request hostname. The endpoint is responsible for retrieving a token using `GenerateAccessToken` and redirecting back to the original hostname with the token. + "workstationLaunchUrl": "A String", # Optional. Specifies the launch URL for workstations in this cluster. Requests sent to unstarted workstations will be redirected to this URL. Requests redirected to the launch endpoint will be sent with a `workstation` and `project` query parameter containing the full workstation resource name and project ID, respectively. The launch endpoint is responsible for starting the workstation, polling it until it reaches `STATE_RUNNING`, and then issuing a redirect to the workstation's host URL. } allowMissing: boolean, Optional. If set, and the workstation cluster is not found, a new workstation cluster will be created. In this situation, update_mask is ignored. updateMask: string, Required. Mask that specifies which fields in the workstation cluster should be updated. - validateOnly: boolean, Optional. If set, validate the request and preview the review, but do not actually apply it. + validateOnly: boolean, Optional. If set, validate the request and preview the result, but do not actually apply it. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.workstationConfigs.html b/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.workstationConfigs.html index e4ac48a129..5ad16b0a3d 100644 --- a/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.workstationConfigs.html +++ b/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.workstationConfigs.html @@ -295,14 +295,14 @@

Method Details

"replicaZones": [ # Optional. Immutable. Specifies the zones used to replicate the VM and disk resources within the region. If set, exactly two zones within the workstation cluster's region must be specified—for example, `['us-central1-a', 'us-central1-f']`. If this field is empty, two default zones within the region are used. Immutable after the workstation configuration is created. "A String", ], - "runningTimeout": "A String", # Optional. Number of seconds that a workstation can run until it is automatically shut down. We recommend that workstations be shut down daily to reduce costs and so that security updates can be applied upon restart. The idle_timeout and running_timeout fields are independent of each other. Note that the running_timeout field shuts down VMs after the specified time, regardless of whether or not the VMs are idle. Provide duration terminated by `s` for seconds—for example, `"54000s"` (15 hours). Defaults to `"43200s"` (12 hours). A value of `"0s"` indicates that workstations using this configuration should never time out. If encryption_key is set, it must be greater than `"0s"` and less than `"86400s"` (24 hours). Warning: A value of `"0s"` indicates that Cloud Workstations VMs created with this configuration have no maximum running time. This is strongly discouraged because you incur costs and will not pick up security updates. + "runningTimeout": "A String", # Optional. Number of seconds that a workstation can run until it is automatically shut down. This field applies to workstations in both STATE_RUNNING and STATE_SUSPENDED. We recommend that workstations be shut down daily to reduce costs and so that security updates can be applied upon restart. The idle_timeout and running_timeout fields are independent of each other. Note that the running_timeout field shuts down VMs after the specified time, regardless of whether or not the VMs are idle. Provide duration terminated by `s` for seconds—for example, `"54000s"` (15 hours). Defaults to `"43200s"` (12 hours). A value of `"0s"` indicates that workstations using this configuration should never time out. If encryption_key is set, it must be greater than `"0s"` and less than `"86400s"` (24 hours). Warning: A value of `"0s"` indicates that Cloud Workstations VMs created with this configuration have no maximum running time. This is strongly discouraged because you incur costs and will not pick up security updates. "satisfiesPzi": True or False, # Output only. Reserved for future use. "satisfiesPzs": True or False, # Output only. Reserved for future use. "uid": "A String", # Output only. A system-assigned unique identifier for this workstation configuration. "updateTime": "A String", # Output only. Time when this workstation configuration was most recently updated. } - validateOnly: boolean, Optional. If set, validate the request and preview the review, but do not actually apply it. + validateOnly: boolean, Optional. If set, validate the request and preview the result, but do not actually apply it. workstationConfigId: string, Required. ID to use for the workstation configuration. x__xgafv: string, V1 error format. Allowed values @@ -341,7 +341,7 @@

Method Details

name: string, Required. Name of the workstation configuration to delete. (required) etag: string, Optional. If set, the request is rejected if the latest version of the workstation configuration on the server does not have this ETag. force: boolean, Optional. If set, any workstations in the workstation configuration are also deleted. Otherwise, the request works only if the workstation configuration has no workstations. - validateOnly: boolean, Optional. If set, validate the request and preview the review, but do not actually apply it. + validateOnly: boolean, Optional. If set, validate the request and preview the result, but do not actually apply it. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -550,7 +550,7 @@

Method Details

"replicaZones": [ # Optional. Immutable. Specifies the zones used to replicate the VM and disk resources within the region. If set, exactly two zones within the workstation cluster's region must be specified—for example, `['us-central1-a', 'us-central1-f']`. If this field is empty, two default zones within the region are used. Immutable after the workstation configuration is created. "A String", ], - "runningTimeout": "A String", # Optional. Number of seconds that a workstation can run until it is automatically shut down. We recommend that workstations be shut down daily to reduce costs and so that security updates can be applied upon restart. The idle_timeout and running_timeout fields are independent of each other. Note that the running_timeout field shuts down VMs after the specified time, regardless of whether or not the VMs are idle. Provide duration terminated by `s` for seconds—for example, `"54000s"` (15 hours). Defaults to `"43200s"` (12 hours). A value of `"0s"` indicates that workstations using this configuration should never time out. If encryption_key is set, it must be greater than `"0s"` and less than `"86400s"` (24 hours). Warning: A value of `"0s"` indicates that Cloud Workstations VMs created with this configuration have no maximum running time. This is strongly discouraged because you incur costs and will not pick up security updates. + "runningTimeout": "A String", # Optional. Number of seconds that a workstation can run until it is automatically shut down. This field applies to workstations in both STATE_RUNNING and STATE_SUSPENDED. We recommend that workstations be shut down daily to reduce costs and so that security updates can be applied upon restart. The idle_timeout and running_timeout fields are independent of each other. Note that the running_timeout field shuts down VMs after the specified time, regardless of whether or not the VMs are idle. Provide duration terminated by `s` for seconds—for example, `"54000s"` (15 hours). Defaults to `"43200s"` (12 hours). A value of `"0s"` indicates that workstations using this configuration should never time out. If encryption_key is set, it must be greater than `"0s"` and less than `"86400s"` (24 hours). Warning: A value of `"0s"` indicates that Cloud Workstations VMs created with this configuration have no maximum running time. This is strongly discouraged because you incur costs and will not pick up security updates. "satisfiesPzi": True or False, # Output only. Reserved for future use. "satisfiesPzs": True or False, # Output only. Reserved for future use. "uid": "A String", # Output only. A system-assigned unique identifier for this workstation configuration. @@ -794,7 +794,7 @@

Method Details

"replicaZones": [ # Optional. Immutable. Specifies the zones used to replicate the VM and disk resources within the region. If set, exactly two zones within the workstation cluster's region must be specified—for example, `['us-central1-a', 'us-central1-f']`. If this field is empty, two default zones within the region are used. Immutable after the workstation configuration is created. "A String", ], - "runningTimeout": "A String", # Optional. Number of seconds that a workstation can run until it is automatically shut down. We recommend that workstations be shut down daily to reduce costs and so that security updates can be applied upon restart. The idle_timeout and running_timeout fields are independent of each other. Note that the running_timeout field shuts down VMs after the specified time, regardless of whether or not the VMs are idle. Provide duration terminated by `s` for seconds—for example, `"54000s"` (15 hours). Defaults to `"43200s"` (12 hours). A value of `"0s"` indicates that workstations using this configuration should never time out. If encryption_key is set, it must be greater than `"0s"` and less than `"86400s"` (24 hours). Warning: A value of `"0s"` indicates that Cloud Workstations VMs created with this configuration have no maximum running time. This is strongly discouraged because you incur costs and will not pick up security updates. + "runningTimeout": "A String", # Optional. Number of seconds that a workstation can run until it is automatically shut down. This field applies to workstations in both STATE_RUNNING and STATE_SUSPENDED. We recommend that workstations be shut down daily to reduce costs and so that security updates can be applied upon restart. The idle_timeout and running_timeout fields are independent of each other. Note that the running_timeout field shuts down VMs after the specified time, regardless of whether or not the VMs are idle. Provide duration terminated by `s` for seconds—for example, `"54000s"` (15 hours). Defaults to `"43200s"` (12 hours). A value of `"0s"` indicates that workstations using this configuration should never time out. If encryption_key is set, it must be greater than `"0s"` and less than `"86400s"` (24 hours). Warning: A value of `"0s"` indicates that Cloud Workstations VMs created with this configuration have no maximum running time. This is strongly discouraged because you incur costs and will not pick up security updates. "satisfiesPzi": True or False, # Output only. Reserved for future use. "satisfiesPzs": True or False, # Output only. Reserved for future use. "uid": "A String", # Output only. A system-assigned unique identifier for this workstation configuration. @@ -991,7 +991,7 @@

Method Details

"replicaZones": [ # Optional. Immutable. Specifies the zones used to replicate the VM and disk resources within the region. If set, exactly two zones within the workstation cluster's region must be specified—for example, `['us-central1-a', 'us-central1-f']`. If this field is empty, two default zones within the region are used. Immutable after the workstation configuration is created. "A String", ], - "runningTimeout": "A String", # Optional. Number of seconds that a workstation can run until it is automatically shut down. We recommend that workstations be shut down daily to reduce costs and so that security updates can be applied upon restart. The idle_timeout and running_timeout fields are independent of each other. Note that the running_timeout field shuts down VMs after the specified time, regardless of whether or not the VMs are idle. Provide duration terminated by `s` for seconds—for example, `"54000s"` (15 hours). Defaults to `"43200s"` (12 hours). A value of `"0s"` indicates that workstations using this configuration should never time out. If encryption_key is set, it must be greater than `"0s"` and less than `"86400s"` (24 hours). Warning: A value of `"0s"` indicates that Cloud Workstations VMs created with this configuration have no maximum running time. This is strongly discouraged because you incur costs and will not pick up security updates. + "runningTimeout": "A String", # Optional. Number of seconds that a workstation can run until it is automatically shut down. This field applies to workstations in both STATE_RUNNING and STATE_SUSPENDED. We recommend that workstations be shut down daily to reduce costs and so that security updates can be applied upon restart. The idle_timeout and running_timeout fields are independent of each other. Note that the running_timeout field shuts down VMs after the specified time, regardless of whether or not the VMs are idle. Provide duration terminated by `s` for seconds—for example, `"54000s"` (15 hours). Defaults to `"43200s"` (12 hours). A value of `"0s"` indicates that workstations using this configuration should never time out. If encryption_key is set, it must be greater than `"0s"` and less than `"86400s"` (24 hours). Warning: A value of `"0s"` indicates that Cloud Workstations VMs created with this configuration have no maximum running time. This is strongly discouraged because you incur costs and will not pick up security updates. "satisfiesPzi": True or False, # Output only. Reserved for future use. "satisfiesPzs": True or False, # Output only. Reserved for future use. "uid": "A String", # Output only. A system-assigned unique identifier for this workstation configuration. @@ -1203,7 +1203,7 @@

Method Details

"replicaZones": [ # Optional. Immutable. Specifies the zones used to replicate the VM and disk resources within the region. If set, exactly two zones within the workstation cluster's region must be specified—for example, `['us-central1-a', 'us-central1-f']`. If this field is empty, two default zones within the region are used. Immutable after the workstation configuration is created. "A String", ], - "runningTimeout": "A String", # Optional. Number of seconds that a workstation can run until it is automatically shut down. We recommend that workstations be shut down daily to reduce costs and so that security updates can be applied upon restart. The idle_timeout and running_timeout fields are independent of each other. Note that the running_timeout field shuts down VMs after the specified time, regardless of whether or not the VMs are idle. Provide duration terminated by `s` for seconds—for example, `"54000s"` (15 hours). Defaults to `"43200s"` (12 hours). A value of `"0s"` indicates that workstations using this configuration should never time out. If encryption_key is set, it must be greater than `"0s"` and less than `"86400s"` (24 hours). Warning: A value of `"0s"` indicates that Cloud Workstations VMs created with this configuration have no maximum running time. This is strongly discouraged because you incur costs and will not pick up security updates. + "runningTimeout": "A String", # Optional. Number of seconds that a workstation can run until it is automatically shut down. This field applies to workstations in both STATE_RUNNING and STATE_SUSPENDED. We recommend that workstations be shut down daily to reduce costs and so that security updates can be applied upon restart. The idle_timeout and running_timeout fields are independent of each other. Note that the running_timeout field shuts down VMs after the specified time, regardless of whether or not the VMs are idle. Provide duration terminated by `s` for seconds—for example, `"54000s"` (15 hours). Defaults to `"43200s"` (12 hours). A value of `"0s"` indicates that workstations using this configuration should never time out. If encryption_key is set, it must be greater than `"0s"` and less than `"86400s"` (24 hours). Warning: A value of `"0s"` indicates that Cloud Workstations VMs created with this configuration have no maximum running time. This is strongly discouraged because you incur costs and will not pick up security updates. "satisfiesPzi": True or False, # Output only. Reserved for future use. "satisfiesPzs": True or False, # Output only. Reserved for future use. "uid": "A String", # Output only. A system-assigned unique identifier for this workstation configuration. @@ -1212,7 +1212,7 @@

Method Details

allowMissing: boolean, Optional. If set and the workstation configuration is not found, a new workstation configuration will be created. In this situation, update_mask is ignored. updateMask: string, Required. Mask specifying which fields in the workstation configuration should be updated. - validateOnly: boolean, Optional. If set, validate the request and preview the review, but do not actually apply it. + validateOnly: boolean, Optional. If set, validate the request and preview the result, but do not actually apply it. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.workstationConfigs.workstations.html b/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.workstationConfigs.workstations.html index ab1fc2f014..75695ef0d7 100644 --- a/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.workstationConfigs.workstations.html +++ b/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.workstationConfigs.workstations.html @@ -186,7 +186,7 @@

Method Details

"updateTime": "A String", # Output only. Time when this workstation was most recently updated. } - validateOnly: boolean, Optional. If set, validate the request and preview the review, but do not actually apply it. + validateOnly: boolean, Optional. If set, validate the request and preview the result, but do not actually apply it. workstationId: string, Required. ID to use for the workstation. x__xgafv: string, V1 error format. Allowed values @@ -224,7 +224,7 @@

Method Details

Args: name: string, Required. Name of the workstation to delete. (required) etag: string, Optional. If set, the request will be rejected if the latest version of the workstation on the server does not have this ETag. - validateOnly: boolean, Optional. If set, validate the request and preview the review, but do not actually apply it. + validateOnly: boolean, Optional. If set, validate the request and preview the result, but do not actually apply it. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -642,9 +642,9 @@

Method Details

"updateTime": "A String", # Output only. Time when this workstation was most recently updated. } - allowMissing: boolean, Optional. If set and the workstation configuration is not found, a new workstation configuration is created. In this situation, update_mask is ignored. - updateMask: string, Required. Mask specifying which fields in the workstation configuration should be updated. - validateOnly: boolean, Optional. If set, validate the request and preview the review, but do not actually apply it. + allowMissing: boolean, Optional. If set and the workstation is not found, a new workstation is created. In this situation, update_mask is ignored. + updateMask: string, Required. Mask specifying which fields in the workstation should be updated. + validateOnly: boolean, Optional. If set, validate the request and preview the result, but do not actually apply it. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -771,7 +771,7 @@

Method Details

{ # Request message for StartWorkstation. "boostConfig": "A String", # Optional. If set, the workstation starts using the boost configuration with the specified ID. "etag": "A String", # Optional. If set, the request will be rejected if the latest version of the workstation on the server does not have this ETag. - "validateOnly": True or False, # Optional. If set, validate the request and preview the review, but do not actually apply it. + "validateOnly": True or False, # Optional. If set, validate the request and preview the result, but do not actually apply it. } x__xgafv: string, V1 error format. @@ -814,7 +814,7 @@

Method Details

{ # Request message for StopWorkstation. "etag": "A String", # Optional. If set, the request will be rejected if the latest version of the workstation on the server does not have this ETag. - "validateOnly": True or False, # Optional. If set, validate the request and preview the review, but do not actually apply it. + "validateOnly": True or False, # Optional. If set, validate the request and preview the result, but do not actually apply it. } x__xgafv: string, V1 error format. diff --git a/googleapiclient/discovery_cache/documents/accesscontextmanager.v1.json b/googleapiclient/discovery_cache/documents/accesscontextmanager.v1.json index d8d162c828..487c574727 100644 --- a/googleapiclient/discovery_cache/documents/accesscontextmanager.v1.json +++ b/googleapiclient/discovery_cache/documents/accesscontextmanager.v1.json @@ -1331,7 +1331,7 @@ } } }, -"revision": "20260311", +"revision": "20260329", "rootUrl": "https://accesscontextmanager.googleapis.com/", "schemas": { "AccessContextManagerOperationMetadata": { @@ -1786,7 +1786,7 @@ "id": "EgressFrom", "properties": { "identities": { -"description": "A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities.", +"description": "A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, third-party identity, or agent identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities.", "items": { "type": "string" }, @@ -2011,7 +2011,7 @@ "id": "IngressFrom", "properties": { "identities": { -"description": "A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities.", +"description": "A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, third-party identity, or agent identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities.", "items": { "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/agentregistry.v1alpha.json b/googleapiclient/discovery_cache/documents/agentregistry.v1alpha.json index 443ce95c58..6816efdf52 100644 --- a/googleapiclient/discovery_cache/documents/agentregistry.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/agentregistry.v1alpha.json @@ -272,6 +272,37 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] +}, +"search": { +"description": "Searches Agents in a given project and location.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/agents:search", +"httpMethod": "POST", +"id": "agentregistry.projects.locations.agents.search", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. Parent value for SearchAgentsRequest. Format: `projects/{project}/locations/{location}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+parent}/agents:search", +"request": { +"$ref": "SearchAgentsRequest" +}, +"response": { +"$ref": "SearchAgentsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/agentregistry.read-only", +"https://www.googleapis.com/auth/agentregistry.read-write", +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only" +] } } }, @@ -429,6 +460,37 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] +}, +"search": { +"description": "Searches McpServers in a given project and location.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/mcpServers:search", +"httpMethod": "POST", +"id": "agentregistry.projects.locations.mcpServers.search", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. Parent value for SearchMcpServersRequest. Format: `projects/{project}/locations/{location}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+parent}/mcpServers:search", +"request": { +"$ref": "SearchMcpServersRequest" +}, +"response": { +"$ref": "SearchMcpServersResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/agentregistry.read-only", +"https://www.googleapis.com/auth/agentregistry.read-write", +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only" +] } } }, @@ -757,7 +819,7 @@ } } }, -"revision": "20260326", +"revision": "20260406", "rootUrl": "https://agentregistry.googleapis.com/", "schemas": { "Agent": { @@ -1417,6 +1479,82 @@ }, "type": "object" }, +"SearchAgentsRequest": { +"description": "Message for searching Agents", +"id": "SearchAgentsRequest", +"properties": { +"pageSize": { +"description": "Optional. The maximum number of search results to return per page. The page size is capped at `100`, even if a larger value is specified. A negative value will result in an `INVALID_ARGUMENT` error. If unspecified or set to `0`, a default value of `20` will be used. The server may return fewer results than requested.", +"format": "int32", +"type": "integer" +}, +"pageToken": { +"description": "Optional. If present, retrieve the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of all other method parameters, must be identical to those in the previous call.", +"type": "string" +}, +"searchString": { +"description": "Optional. Search criteria used to select the Agents to return. If no search criteria is specified then all accessible Agents will be returned. Search expressions can be used to restrict results based upon searchable fields, where the operators can be used along with the suffix wildcard symbol `*`. See [instructions](https://docs.cloud.google.com/agent-registry/search-agents-and-tools) for more details. Allowed operators: `=`, `:`, `NOT`, `AND`, `OR`, and `()`. Searchable fields: | Field | `=` | `:` | `*` | Keyword Search | |--------------------|-----|-----|-----|----------------| | agentId | Yes | Yes | Yes | Included | | name | No | Yes | Yes | Included | | displayName | No | Yes | Yes | Included | | description | No | Yes | No | Included | | skills | No | Yes | No | Included | | skills.id | No | Yes | No | Included | | skills.name | No | Yes | No | Included | | skills.description | No | Yes | No | Included | | skills.tags | No | Yes | No | Included | | skills.examples | No | Yes | No | Included | Examples: * `agentId=urn:agent:projects-123:projects:123:locations:us-central1:reasoningEngines:1234` to find the agent with the specified agent ID. * `name:important` to find agents whose name contains `important` as a word. * `displayName:works*` to find agents whose display name contains words that start with `works`. * `skills.tags:test` to find agents whose skills tags contain `test`. * `planner OR booking` to find agents whose metadata contains the words `planner` or `booking`.", +"type": "string" +} +}, +"type": "object" +}, +"SearchAgentsResponse": { +"description": "Message for response to searching Agents", +"id": "SearchAgentsResponse", +"properties": { +"agents": { +"description": "A list of Agents that match the `search_string`.", +"items": { +"$ref": "Agent" +}, +"type": "array" +}, +"nextPageToken": { +"description": "If there are more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token`.", +"type": "string" +} +}, +"type": "object" +}, +"SearchMcpServersRequest": { +"description": "Message for searching MCP Servers", +"id": "SearchMcpServersRequest", +"properties": { +"pageSize": { +"description": "Optional. The maximum number of search results to return per page. The page size is capped at `100`, even if a larger value is specified. A negative value will result in an `INVALID_ARGUMENT` error. If unspecified or set to `0`, a default value of `20` will be used. The server may return fewer results than requested.", +"format": "int32", +"type": "integer" +}, +"pageToken": { +"description": "Optional. If present, retrieve the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of all other method parameters, must be identical to those in the previous call.", +"type": "string" +}, +"searchString": { +"description": "Optional. Search criteria used to select the MCP Servers to return. If no search criteria is specified then all accessible MCP Servers will be returned. Search expressions can be used to restrict results based upon searchable fields, where the operators can be used along with the suffix wildcard symbol `*`. See [instructions](https://docs.cloud.google.com/agent-registry/search-agents-and-tools) for more details. Allowed operators: `=`, `:`, `NOT`, `AND`, `OR`, and `()`. Searchable fields: | Field | `=` | `:` | `*` | Keyword Search | |--------------------|-----|-----|-----|----------------| | mcpServerId | Yes | Yes | Yes | Included | | name | No | Yes | Yes | Included | | displayName | No | Yes | Yes | Included | Examples: * `mcpServerId=urn:mcp:projects-123:projects:123:locations:us-central1:agentregistry:services:service-id` to find the MCP Server with the specified MCP Server ID. * `name:important` to find MCP Servers whose name contains `important` as a word. * `displayName:works*` to find MCP Servers whose display name contains words that start with `works`. * `planner OR booking` to find MCP Servers whose metadata contains the words `planner` or `booking`. * `mcpServerId:service-id AND (displayName:planner OR displayName:booking)` to find MCP Servers whose MCP Server ID contains `service-id` and whose display name contains `planner` or `booking`.", +"type": "string" +} +}, +"type": "object" +}, +"SearchMcpServersResponse": { +"description": "Message for response to searching MCP Servers", +"id": "SearchMcpServersResponse", +"properties": { +"mcpServers": { +"description": "A list of McpServers that match the `search_string`.", +"items": { +"$ref": "McpServer" +}, +"type": "array" +}, +"nextPageToken": { +"description": "If there are more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token`.", +"type": "string" +} +}, +"type": "object" +}, "Service": { "description": "Represents a user-defined Service.", "id": "Service", diff --git a/googleapiclient/discovery_cache/documents/aiplatform.v1.json b/googleapiclient/discovery_cache/documents/aiplatform.v1.json index 079633c206..7ca58d2ca4 100644 --- a/googleapiclient/discovery_cache/documents/aiplatform.v1.json +++ b/googleapiclient/discovery_cache/documents/aiplatform.v1.json @@ -2201,7 +2201,7 @@ ] }, "predict": { -"description": "Perform an online prediction.", +"description": "", "flatPath": "v1/endpoints/{endpointsId}:predict", "httpMethod": "POST", "id": "aiplatform.endpoints.predict", @@ -10080,7 +10080,7 @@ ] }, "predict": { -"description": "Perform an online prediction.", +"description": "", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:predict", "httpMethod": "POST", "id": "aiplatform.projects.locations.endpoints.predict", @@ -21215,7 +21215,7 @@ ] }, "predict": { -"description": "Perform an online prediction.", +"description": "", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:predict", "httpMethod": "POST", "id": "aiplatform.projects.locations.publishers.models.predict", @@ -27688,7 +27688,7 @@ ] }, "predict": { -"description": "Perform an online prediction.", +"description": "", "flatPath": "v1/publishers/{publishersId}/models/{modelsId}:predict", "httpMethod": "POST", "id": "aiplatform.publishers.models.predict", @@ -30865,13 +30865,20 @@ } } }, -"revision": "20260320", +"revision": "20260329", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { "CloudAiLargeModelsVisionGenerateVideoExperiments": { "description": "Experimental parameters for video generation.", "id": "CloudAiLargeModelsVisionGenerateVideoExperiments", "properties": { +"conditioningFrames": { +"description": "Conditioning frames for veo experimental models ONLY, not to be confused with keyframes (ID:31) in GenerateVideoRequest.", +"items": { +"$ref": "CloudAiLargeModelsVisionGenerateVideoExperimentsConditioningFrame" +}, +"type": "array" +}, "humanPose": { "$ref": "CloudAiLargeModelsVisionHumanPose", "description": "Human pose parameters for Pose Control" @@ -30901,6 +30908,43 @@ }, "type": "object" }, +"CloudAiLargeModelsVisionGenerateVideoExperimentsConditioningFrame": { +"id": "CloudAiLargeModelsVisionGenerateVideoExperimentsConditioningFrame", +"properties": { +"frameNum": { +"description": "The index of the frame, starts with zero and must be a multiple of 8.", +"format": "int32", +"type": "integer" +}, +"image": { +"$ref": "CloudAiLargeModelsVisionGenerateVideoRequestImage", +"description": "The image data for this conditioning frame." +} +}, +"type": "object" +}, +"CloudAiLargeModelsVisionGenerateVideoRequestImage": { +"description": "The image bytes or Cloud Storage URI to make the prediction on.", +"id": "CloudAiLargeModelsVisionGenerateVideoRequestImage", +"properties": { +"blobId": { +"description": "Blob ID of the image. This is used for storing the large images in the request.", +"type": "string" +}, +"bytesBase64Encoded": { +"description": "Base64 encoded bytes string representing the image.", +"type": "string" +}, +"gcsUri": { +"type": "string" +}, +"mimeType": { +"description": "The MIME type of the content of the image. Only the images in below listed MIME types are supported. - image/jpeg - image/png", +"type": "string" +} +}, +"type": "object" +}, "CloudAiLargeModelsVisionGenerateVideoResponse": { "description": "Generate video response.", "id": "CloudAiLargeModelsVisionGenerateVideoResponse", @@ -30966,6 +31010,10 @@ "faceLandmarksGcsUri": { "description": "GCS URI of the face landmarks video to condition video generation.", "type": "string" +}, +"perfMeshGcsUri": { +"description": "GCS URI of the performance mesh to condition video generation.", +"type": "string" } }, "type": "object" @@ -37638,7 +37686,8 @@ "FAILED", "CANCELLED", "INFERENCE", -"GENERATING_RUBRICS" +"GENERATING_RUBRICS", +"GENERATING_LOSS_CLUSTERS" ], "enumDescriptions": [ "Unspecified state.", @@ -37648,7 +37697,8 @@ "The evaluation run has failed.", "The evaluation run has been cancelled.", "The evaluation run is performing inference.", -"The evaluation run is performing rubric generation." +"The evaluation run is performing rubric generation.", +"The evaluation run is performing loss analysis." ], "readOnly": true, "type": "string" @@ -45081,7 +45131,7 @@ false "type": "string" }, "fact": { -"description": "Required. Semantic knowledge extracted from the source content.", +"description": "Optional. Semantic knowledge extracted from the source content.", "type": "string" }, "metadata": { diff --git a/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json b/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json index db9ff45760..ae0716e057 100644 --- a/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json @@ -2682,7 +2682,7 @@ ] }, "predict": { -"description": "Perform an online prediction.", +"description": "", "flatPath": "v1beta1/endpoints/{endpointsId}:predict", "httpMethod": "POST", "id": "aiplatform.endpoints.predict", @@ -8521,6 +8521,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"generateLossClusters": { +"description": "Generates loss clusters from evaluation results. This is a statelss API method that would not modify the EvaluationSet resource.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:generateLossClusters", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.generateLossClusters", +"parameterOrder": [ +"location" +], +"parameters": { +"location": { +"description": "Required. The resource name of the Location. Format: `projects/{project}/locations/{location}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+location}:generateLossClusters", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1GenerateLossClustersRequest" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "generateSyntheticData": { "description": "Generates synthetic (artificial) data based on a description", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:generateSyntheticData", @@ -12681,7 +12709,7 @@ ] }, "predict": { -"description": "Perform an online prediction.", +"description": "", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:predict", "httpMethod": "POST", "id": "aiplatform.projects.locations.endpoints.predict", @@ -25732,6 +25760,224 @@ } } }, +"onlineEvaluators": { +"methods": { +"activate": { +"description": "Activates an OnlineEvaluator.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/onlineEvaluators/{onlineEvaluatorsId}:activate", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.onlineEvaluators.activate", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the OnlineEvaluator to activate. Format: projects/{project}/locations/{location}/onlineEvaluators/{id}.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/onlineEvaluators/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}:activate", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1ActivateOnlineEvaluatorRequest" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"create": { +"description": "Creates an OnlineEvaluator in the given project and location.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/onlineEvaluators", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.onlineEvaluators.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The parent resource where the OnlineEvaluator will be created. Format: projects/{project}/locations/{location}.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+parent}/onlineEvaluators", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1OnlineEvaluator" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes an OnlineEvaluator.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/onlineEvaluators/{onlineEvaluatorsId}", +"httpMethod": "DELETE", +"id": "aiplatform.projects.locations.onlineEvaluators.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the OnlineEvaluator to delete. Format: projects/{project}/locations/{location}/onlineEvaluators/{id}.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/onlineEvaluators/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets details of an OnlineEvaluator.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/onlineEvaluators/{onlineEvaluatorsId}", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.onlineEvaluators.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the OnlineEvaluator to retrieve. Format: projects/{project}/locations/{location}/onlineEvaluators/{id}.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/onlineEvaluators/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "GoogleCloudAiplatformV1beta1OnlineEvaluator" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists the OnlineEvaluators for the given project and location.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/onlineEvaluators", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.onlineEvaluators.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. Standard list filter. Supported fields: * `create_time` * `update_time` * `agent_resource` Example: `create_time>\"2026-01-01T00:00:00-04:00\"` where the timestamp is in RFC 3339 format) Based on aip.dev/160.", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Optional. A comma-separated list of fields to order by. The default sorting order is ascending. Use \"desc\" after a field name for descending. Supported fields: * `create_time` * `update_time` Example: `create_time desc`. Based on aip.dev/132.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. The maximum number of OnlineEvaluators to return. The service may return fewer than this value. If unspecified, at most 50 OnlineEvaluators will be returned. The maximum value is 100; values above 100 will be coerced to 100. Based on aip.dev/158.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A token identifying a page of results the server should return. Based on aip.dev/158.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent resource of the OnlineEvaluators to list. Format: projects/{project}/locations/{location}.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+parent}/onlineEvaluators", +"response": { +"$ref": "GoogleCloudAiplatformV1beta1ListOnlineEvaluatorsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Updates the fields of an OnlineEvaluator.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/onlineEvaluators/{onlineEvaluatorsId}", +"httpMethod": "PATCH", +"id": "aiplatform.projects.locations.onlineEvaluators.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Identifier. The resource name of the OnlineEvaluator. Format: projects/{project}/locations/{location}/onlineEvaluators/{id}.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/onlineEvaluators/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1OnlineEvaluator" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"suspend": { +"description": "Suspends an OnlineEvaluator. When an OnlineEvaluator is suspended, it won't run any evaluations until it is activated again.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/onlineEvaluators/{onlineEvaluatorsId}:suspend", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.onlineEvaluators.suspend", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the OnlineEvaluator to suspend. Format: projects/{project}/locations/{location}/onlineEvaluators/{id}.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/onlineEvaluators/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}:suspend", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1SuspendOnlineEvaluatorRequest" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, "operations": { "methods": { "cancel": { @@ -26853,7 +27099,7 @@ ] }, "predict": { -"description": "Perform an online prediction.", +"description": "", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:predict", "httpMethod": "POST", "id": "aiplatform.projects.locations.publishers.models.predict", @@ -35683,7 +35929,7 @@ ] }, "predict": { -"description": "Perform an online prediction.", +"description": "", "flatPath": "v1beta1/publishers/{publishersId}/models/{modelsId}:predict", "httpMethod": "POST", "id": "aiplatform.publishers.models.predict", @@ -40964,13 +41210,20 @@ } } }, -"revision": "20260320", +"revision": "20260329", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { "CloudAiLargeModelsVisionGenerateVideoExperiments": { "description": "Experimental parameters for video generation.", "id": "CloudAiLargeModelsVisionGenerateVideoExperiments", "properties": { +"conditioningFrames": { +"description": "Conditioning frames for veo experimental models ONLY, not to be confused with keyframes (ID:31) in GenerateVideoRequest.", +"items": { +"$ref": "CloudAiLargeModelsVisionGenerateVideoExperimentsConditioningFrame" +}, +"type": "array" +}, "humanPose": { "$ref": "CloudAiLargeModelsVisionHumanPose", "description": "Human pose parameters for Pose Control" @@ -41000,6 +41253,43 @@ }, "type": "object" }, +"CloudAiLargeModelsVisionGenerateVideoExperimentsConditioningFrame": { +"id": "CloudAiLargeModelsVisionGenerateVideoExperimentsConditioningFrame", +"properties": { +"frameNum": { +"description": "The index of the frame, starts with zero and must be a multiple of 8.", +"format": "int32", +"type": "integer" +}, +"image": { +"$ref": "CloudAiLargeModelsVisionGenerateVideoRequestImage", +"description": "The image data for this conditioning frame." +} +}, +"type": "object" +}, +"CloudAiLargeModelsVisionGenerateVideoRequestImage": { +"description": "The image bytes or Cloud Storage URI to make the prediction on.", +"id": "CloudAiLargeModelsVisionGenerateVideoRequestImage", +"properties": { +"blobId": { +"description": "Blob ID of the image. This is used for storing the large images in the request.", +"type": "string" +}, +"bytesBase64Encoded": { +"description": "Base64 encoded bytes string representing the image.", +"type": "string" +}, +"gcsUri": { +"type": "string" +}, +"mimeType": { +"description": "The MIME type of the content of the image. Only the images in below listed MIME types are supported. - image/jpeg - image/png", +"type": "string" +} +}, +"type": "object" +}, "CloudAiLargeModelsVisionGenerateVideoResponse": { "description": "Generate video response.", "id": "CloudAiLargeModelsVisionGenerateVideoResponse", @@ -41065,6 +41355,10 @@ "faceLandmarksGcsUri": { "description": "GCS URI of the face landmarks video to condition video generation.", "type": "string" +}, +"perfMeshGcsUri": { +"description": "GCS URI of the performance mesh to condition video generation.", +"type": "string" } }, "type": "object" @@ -41585,6 +41879,12 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1beta1ActivateOnlineEvaluatorRequest": { +"description": "Request message for ActivateOnlineEvaluator.", +"id": "GoogleCloudAiplatformV1beta1ActivateOnlineEvaluatorRequest", +"properties": {}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1ActiveLearningConfig": { "description": "Parameters that configure the active learning pipeline. Active learning will label the data incrementally by several iterations. For every iteration, it will select a batch of data based on the sampling strategy.", "id": "GoogleCloudAiplatformV1beta1ActiveLearningConfig", @@ -47000,6 +47300,10 @@ "description": "Deprecated. A path in a Cloud Storage bucket, which will be treated as the root output directory of the distillation pipeline. It is used by the system to generate the paths of output artifacts.", "type": "string" }, +"promptDatasetUri": { +"description": "Optional. Cloud Storage path to file containing prompt dataset for distillation. The dataset must be formatted as a JSONL file.", +"type": "string" +}, "studentModel": { "deprecated": true, "description": "The student model that is being tuned, e.g., \"google/gemma-2b-1.1-it\". Deprecated. Use base_model instead.", @@ -48597,6 +48901,14 @@ "description": "The evaluation set where item level results are stored.", "type": "string" }, +"lossAnalysisResults": { +"description": "Output only. The results of the auto-loss analysis performed on the eval set associated with the run.", +"items": { +"$ref": "GoogleCloudAiplatformV1beta1LossAnalysisResult" +}, +"readOnly": true, +"type": "array" +}, "summaryMetrics": { "$ref": "GoogleCloudAiplatformV1beta1SummaryMetrics", "description": "Optional. The summary metrics for the evaluation run." @@ -48698,7 +49010,8 @@ "FAILED", "CANCELLED", "INFERENCE", -"GENERATING_RUBRICS" +"GENERATING_RUBRICS", +"GENERATING_LOSS_CLUSTERS" ], "enumDescriptions": [ "Unspecified state.", @@ -48708,7 +49021,8 @@ "The evaluation run has failed.", "The evaluation run has been cancelled.", "The evaluation run is performing inference.", -"The evaluation run is performing rubric generation." +"The evaluation run is performing rubric generation.", +"The evaluation run is performing loss analysis." ], "readOnly": true, "type": "string" @@ -48746,6 +49060,13 @@ }, "type": "array" }, +"lossAnalysisConfig": { +"description": "Optional. Specifications for loss analysis. Each config can be specified for one metric.", +"items": { +"$ref": "GoogleCloudAiplatformV1beta1LossAnalysisConfig" +}, +"type": "array" +}, "metrics": { "description": "Required. The metrics to be calculated in the evaluation run.", "items": { @@ -50823,6 +51144,21 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1beta1FailedRubric": { +"description": "Represents a specific failed rubric and the associated analysis.", +"id": "GoogleCloudAiplatformV1beta1FailedRubric", +"properties": { +"classificationRationale": { +"description": "The rationale provided by the Loss Analysis Classifier for why this failure maps to this specific Loss Cluster. e.g., \"The agent claimed an action without a tool call, matching 'Hallucination of Action'.\"", +"type": "string" +}, +"rubricId": { +"description": "The unique ID of the rubric (if available from the metric source). Clients use this ID to query the corresponding rubric verdict.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1FasterDeploymentConfig": { "description": "Configuration for faster model deployment.", "id": "GoogleCloudAiplatformV1beta1FasterDeploymentConfig", @@ -53665,6 +54001,72 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1beta1GenerateLossClustersOperationMetadata": { +"description": "Operation metadata for EvaluationAnalyticsService.GenerateLossClusters.", +"id": "GoogleCloudAiplatformV1beta1GenerateLossClustersOperationMetadata", +"properties": { +"genericMetadata": { +"$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata", +"description": "Generic operation metadata." +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1GenerateLossClustersRequest": { +"description": "Request message for EvaluationAnalyticsService.GenerateLossClusters.", +"id": "GoogleCloudAiplatformV1beta1GenerateLossClustersRequest", +"properties": { +"configs": { +"description": "Required. Configuration for the analysis algorithm. Analysis for multiple metrics and multiple candidates could be specified.", +"items": { +"$ref": "GoogleCloudAiplatformV1beta1LossAnalysisConfig" +}, +"type": "array" +}, +"evaluationSet": { +"description": "Reference to a persisted EvaluationSet. The service will read items from this set.", +"type": "string" +}, +"inlineResults": { +"$ref": "GoogleCloudAiplatformV1beta1GenerateLossClustersRequestEvaluationResultList", +"description": "Inline evaluation results. Useful for ephemeral analysis in notebooks/SDKs where data isn't persisted." +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1GenerateLossClustersRequestEvaluationResultList": { +"description": "A wrapper to allow providing a list of items inline.", +"id": "GoogleCloudAiplatformV1beta1GenerateLossClustersRequestEvaluationResultList", +"properties": { +"evaluationResults": { +"description": "Required. The list of evaluation results to analyze.", +"items": { +"$ref": "GoogleCloudAiplatformV1beta1EvaluationResult" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1GenerateLossClustersResponse": { +"description": "Response message for EvaluationAnalyticsService.GenerateLossClusters.", +"id": "GoogleCloudAiplatformV1beta1GenerateLossClustersResponse", +"properties": { +"analysisTime": { +"description": "The timestamp when this analysis was completed.", +"format": "google-datetime", +"type": "string" +}, +"results": { +"description": "The analysis results, one per config provided in the request.", +"items": { +"$ref": "GoogleCloudAiplatformV1beta1LossAnalysisResult" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1GenerateMemoriesRequest": { "description": "Request message for MemoryBankService.GenerateMemories. Maximum size is 8 MB.", "id": "GoogleCloudAiplatformV1beta1GenerateMemoriesRequest", @@ -56932,6 +57334,24 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1beta1ListOnlineEvaluatorsResponse": { +"description": "Response message for ListOnlineEvaluators.", +"id": "GoogleCloudAiplatformV1beta1ListOnlineEvaluatorsResponse", +"properties": { +"nextPageToken": { +"description": "A token to retrieve the next page. Absence of this field indicates there are no subsequent pages.", +"type": "string" +}, +"onlineEvaluators": { +"description": "A list of OnlineEvaluators matching the request.", +"items": { +"$ref": "GoogleCloudAiplatformV1beta1OnlineEvaluator" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1ListOptimalTrialsRequest": { "description": "Request message for VizierService.ListOptimalTrials.", "id": "GoogleCloudAiplatformV1beta1ListOptimalTrialsRequest", @@ -57396,6 +57816,112 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1beta1LossAnalysisConfig": { +"description": "Configuration for the loss analysis job.", +"id": "GoogleCloudAiplatformV1beta1LossAnalysisConfig", +"properties": { +"candidate": { +"description": "Required. The candidate model/agent to analyze (e.g., \"gemini-3.0-pro\"). This targets the specific CandidateResult within the EvaluationResult.", +"type": "string" +}, +"metric": { +"description": "Required. The metric to analyze (e.g., \"tool_use_quality\"). This filters the EvaluationItems in the EvalSet to only those where EvaluationResult.metric matches this value.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1LossAnalysisResult": { +"description": "The top-level result for loss analysis, stored within an EvalSet.", +"id": "GoogleCloudAiplatformV1beta1LossAnalysisResult", +"properties": { +"analysisTime": { +"description": "The timestamp when this analysis was performed.", +"format": "google-datetime", +"type": "string" +}, +"clusters": { +"description": "The list of identified loss clusters.", +"items": { +"$ref": "GoogleCloudAiplatformV1beta1LossCluster" +}, +"type": "array" +}, +"config": { +"$ref": "GoogleCloudAiplatformV1beta1LossAnalysisConfig", +"description": "The configuration used to generate this analysis." +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1LossCluster": { +"description": "Represents a semantic grouping of failures (e.g., \"Hallucination of Action\").", +"id": "GoogleCloudAiplatformV1beta1LossCluster", +"properties": { +"clusterId": { +"description": "Unique identifier for the loss cluster within the scope of the analysis result.", +"type": "string" +}, +"examples": { +"description": "A list of examples that belong to this cluster. This links the cluster back to the specific EvaluationItems and Rubrics.", +"items": { +"$ref": "GoogleCloudAiplatformV1beta1LossExample" +}, +"type": "array" +}, +"itemCount": { +"description": "The total number of EvaluationItems falling into this cluster.", +"format": "int32", +"type": "integer" +}, +"taxonomyEntry": { +"$ref": "GoogleCloudAiplatformV1beta1LossTaxonomyEntry", +"description": "The structured definition of the loss taxonomy for this cluster." +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1LossExample": { +"description": "Represents a specific example of a loss pattern.", +"id": "GoogleCloudAiplatformV1beta1LossExample", +"properties": { +"evaluationItem": { +"description": "Reference to the persisted EvalItem resource name. Format: projects/.../locations/.../evaluationItems/{item_id} Used when analysis is run on an EvalSet.", +"type": "string" +}, +"evaluationResult": { +"$ref": "GoogleCloudAiplatformV1beta1EvaluationResult", +"description": "The full evaluation result object provided inline. Used when the analysis is performed on ephemeral data (without an EvaluationSet)." +}, +"failedRubrics": { +"description": "The specific rubric(s) that failed and caused this example to be classified here. An example might fail multiple rubrics, but only specific ones trigger this loss pattern.", +"items": { +"$ref": "GoogleCloudAiplatformV1beta1FailedRubric" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1LossTaxonomyEntry": { +"description": "Defines a specific entry in the loss pattern taxonomy.", +"id": "GoogleCloudAiplatformV1beta1LossTaxonomyEntry", +"properties": { +"description": { +"description": "A detailed description of this loss pattern. Example: \"The agent verbally confirms an action without executing the tool.\"", +"type": "string" +}, +"l1Category": { +"description": "The primary category of the loss (e.g., \"Hallucination\", \"Tool Calling\"). This field is typically required.", +"type": "string" +}, +"l2Category": { +"description": "The secondary category of the loss (e.g., \"Hallucination of Action\", \"Incorrect Tool Selection\").", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1LustreMount": { "description": "Represents a mount configuration for Lustre file system.", "id": "GoogleCloudAiplatformV1beta1LustreMount", @@ -57608,7 +58134,7 @@ false "type": "string" }, "fact": { -"description": "Required. Semantic knowledge extracted from the source content.", +"description": "Optional. Semantic knowledge extracted from the source content.", "type": "string" }, "metadata": { @@ -62045,6 +62571,194 @@ false }, "type": "object" }, +"GoogleCloudAiplatformV1beta1OnlineEvaluator": { +"description": "An OnlineEvaluator contains the configuration for an Online Evaluation.", +"id": "GoogleCloudAiplatformV1beta1OnlineEvaluator", +"properties": { +"agentResource": { +"description": "Required. Immutable. The name of the agent that the OnlineEvaluator evaluates periodically. This value is used to filter the traces with a matching cloud.resource_id and link the evaluation results with relevant dashboards/UIs. This field is immutable. Once set, it cannot be changed.", +"type": "string" +}, +"cloudObservability": { +"$ref": "GoogleCloudAiplatformV1beta1OnlineEvaluatorCloudObservability", +"description": "Data source for the OnlineEvaluator, based on GCP Observability stack (Cloud Trace & Cloud Logging)." +}, +"config": { +"$ref": "GoogleCloudAiplatformV1beta1OnlineEvaluatorConfig", +"description": "Required. Configuration for the OnlineEvaluator." +}, +"createTime": { +"description": "Output only. Timestamp when the OnlineEvaluator was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"displayName": { +"description": "Optional. Human-readable name for the `OnlineEvaluator`. The name doesn't have to be unique. The name can consist of any UTF-8 characters. The maximum length is `63` characters. If the display name exceeds max characters, an `INVALID_ARGUMENT` error is returned.", +"type": "string" +}, +"metricSources": { +"description": "Required. A list of metric sources to be used for evaluating samples. At least one MetricSource must be provided.", +"items": { +"$ref": "GoogleCloudAiplatformV1beta1MetricSource" +}, +"type": "array" +}, +"name": { +"description": "Identifier. The resource name of the OnlineEvaluator. Format: projects/{project}/locations/{location}/onlineEvaluators/{id}.", +"type": "string" +}, +"state": { +"description": "Output only. The state of the OnlineEvaluator.", +"enum": [ +"STATE_UNSPECIFIED", +"ACTIVE", +"SUSPENDED", +"FAILED" +], +"enumDescriptions": [ +"Default value.", +"The OnlineEvaluator is active.", +"The OnlineEvaluator is suspended.", +"The OnlineEvaluator is in a failed state. This can happen, for example, if there user-provided data lacks required information and the evaluation fails." +], +"readOnly": true, +"type": "string" +}, +"updateTime": { +"description": "Output only. Timestamp when the OnlineEvaluator was last updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1OnlineEvaluatorCloudObservability": { +"description": "Data source for the OnlineEvaluator, based on GCP Observability stack (Cloud Trace & Cloud Logging).", +"id": "GoogleCloudAiplatformV1beta1OnlineEvaluatorCloudObservability", +"properties": { +"logView": { +"description": "Optional. Optional log view that will be used to query logs. If empty, the `_Default` view will be used.", +"type": "string" +}, +"openTelemetry": { +"$ref": "GoogleCloudAiplatformV1beta1OnlineEvaluatorCloudObservabilityOpenTelemetry", +"description": "Data source follows OpenTelemetry convention." +}, +"traceScope": { +"$ref": "GoogleCloudAiplatformV1beta1OnlineEvaluatorCloudObservabilityTraceScope", +"description": "Scope online evaluation to single traces." +}, +"traceView": { +"description": "Optional. Optional trace view that will be used to query traces. If empty, the `_Default` view will be used.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1OnlineEvaluatorCloudObservabilityNumericPredicate": { +"description": "Defines a predicate for filtering based on a numeric value.", +"id": "GoogleCloudAiplatformV1beta1OnlineEvaluatorCloudObservabilityNumericPredicate", +"properties": { +"comparisonOperator": { +"description": "Required. The comparison operator to apply.", +"enum": [ +"COMPARISON_OPERATOR_UNSPECIFIED", +"LESS", +"LESS_OR_EQUAL", +"EQUAL", +"NOT_EQUAL", +"GREATER_OR_EQUAL", +"GREATER" +], +"enumDescriptions": [ +"Unspecified comparison operator. This value should not be used.", +"Less than.", +"Less than or equal to.", +"Equal to.", +"Not equal to.", +"Greater than or equal to.", +"Greater than." +], +"type": "string" +}, +"value": { +"description": "Required. The value to compare against.", +"format": "float", +"type": "number" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1OnlineEvaluatorCloudObservabilityOpenTelemetry": { +"description": "Configuration for data source following OpenTelemetry.", +"id": "GoogleCloudAiplatformV1beta1OnlineEvaluatorCloudObservabilityOpenTelemetry", +"properties": { +"semconvVersion": { +"description": "Required. Defines which version OTel Semantic Convention the data follows. Can be \"1.39.0\" or newer.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1OnlineEvaluatorCloudObservabilityTraceScope": { +"description": "Defines the scope and filters for selecting traces.", +"id": "GoogleCloudAiplatformV1beta1OnlineEvaluatorCloudObservabilityTraceScope", +"properties": { +"filter": { +"description": "Optional. A list of predicates to filter traces. Multiple predicates are combined using AND.", +"items": { +"$ref": "GoogleCloudAiplatformV1beta1OnlineEvaluatorCloudObservabilityTraceScopePredicate" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1OnlineEvaluatorCloudObservabilityTraceScopePredicate": { +"description": "Defines a single filter predicate.", +"id": "GoogleCloudAiplatformV1beta1OnlineEvaluatorCloudObservabilityTraceScopePredicate", +"properties": { +"duration": { +"$ref": "GoogleCloudAiplatformV1beta1OnlineEvaluatorCloudObservabilityNumericPredicate", +"description": "Filter on the duration of a trace." +}, +"totalTokenUsage": { +"$ref": "GoogleCloudAiplatformV1beta1OnlineEvaluatorCloudObservabilityNumericPredicate", +"description": "Filter on the total token usage within a trace." +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1OnlineEvaluatorConfig": { +"description": "Configuration for sampling behavior of the OnlineEvaluator. The OnlineEvaluator runs at a fixed interval of 10 minutes.", +"id": "GoogleCloudAiplatformV1beta1OnlineEvaluatorConfig", +"properties": { +"maxEvaluatedSamplesPerRun": { +"description": "Optional. The maximum number of evaluations to perform per run. If set to 0, the number is unbounded.", +"format": "int64", +"type": "string" +}, +"randomSampling": { +"$ref": "GoogleCloudAiplatformV1beta1OnlineEvaluatorConfigRandomSampling", +"description": "Random sampling method." +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1OnlineEvaluatorConfigRandomSampling": { +"description": "Configuration for random sampling.", +"id": "GoogleCloudAiplatformV1beta1OnlineEvaluatorConfigRandomSampling", +"properties": { +"percentage": { +"description": "Required. The percentage of traces to sample for evaluation. Must be an integer between 0 and 100.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1OptimizePromptRequest": { "description": "Request message for GenAiTuningService.OptimizePrompt.", "id": "GoogleCloudAiplatformV1beta1OptimizePromptRequest", @@ -75416,6 +76130,12 @@ false }, "type": "object" }, +"GoogleCloudAiplatformV1beta1SuspendOnlineEvaluatorRequest": { +"description": "Request message for SuspendOnlineEvaluator.", +"id": "GoogleCloudAiplatformV1beta1SuspendOnlineEvaluatorRequest", +"properties": {}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1SyncFeatureViewRequest": { "description": "Request message for FeatureOnlineStoreAdminService.SyncFeatureView.", "id": "GoogleCloudAiplatformV1beta1SyncFeatureViewRequest", @@ -78540,6 +79260,20 @@ false "format": "double", "type": "number" }, +"tuningSpeed": { +"description": "Optional. The speed of the tuning job. Only supported for Veo 3.0 models.", +"enum": [ +"TUNING_SPEED_UNSPECIFIED", +"REGULAR", +"FAST" +], +"enumDescriptions": [ +"The default / unset value. For Veo 3.0 models, this defaults to FAST.", +"Regular tuning speed.", +"Fast tuning speed." +], +"type": "string" +}, "tuningTask": { "description": "Optional. The tuning task. Either I2V or T2V.", "enum": [ diff --git a/googleapiclient/discovery_cache/documents/alloydb.v1.json b/googleapiclient/discovery_cache/documents/alloydb.v1.json index c18e4406ec..6542001926 100644 --- a/googleapiclient/discovery_cache/documents/alloydb.v1.json +++ b/googleapiclient/discovery_cache/documents/alloydb.v1.json @@ -357,7 +357,7 @@ ] }, "list": { -"description": "Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.", +"description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "flatPath": "v1/projects/{projectsId}/locations", "httpMethod": "GET", "id": "alloydb.projects.locations.list", @@ -1879,7 +1879,7 @@ } } }, -"revision": "20260226", +"revision": "20260326", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AuthorizedNetwork": { @@ -3789,6 +3789,11 @@ false "readOnly": true, "type": "string" }, +"isHotStandby": { +"description": "Output only. Indicates whether the node set up to be configured as a hot standby.", +"readOnly": true, +"type": "boolean" +}, "state": { "description": "Output only. Determined by state of the compute VM and postgres-service health. Compute VM state can have values listed in https://cloud.google.com/compute/docs/instances/instance-life-cycle and postgres-service health can have values: HEALTHY and UNHEALTHY.", "readOnly": true, @@ -5269,7 +5274,7 @@ false "type": "object" }, "StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata": { -"description": "Common model for database resource instance metadata. Next ID: 31", +"description": "Common model for database resource instance metadata. Next ID: 32", "id": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata", "properties": { "availabilityConfiguration": { @@ -5387,6 +5392,8 @@ false "SUB_RESOURCE_TYPE_READ_REPLICA", "SUB_RESOURCE_TYPE_EXTERNAL_PRIMARY", "SUB_RESOURCE_TYPE_READ_POOL", +"SUB_RESOURCE_TYPE_RESERVATION", +"SUB_RESOURCE_TYPE_DATASET", "SUB_RESOURCE_TYPE_OTHER" ], "enumDeprecated": [ @@ -5401,6 +5408,8 @@ false, false, false, false, +false, +false, false ], "enumDescriptions": [ @@ -5415,6 +5424,8 @@ false "An instance acting as a read-replica.", "An instance acting as an external primary.", "An instance acting as Read Pool.", +"Represents a reservation resource.", +"Represents a dataset resource.", "For rest of the other categories." ], "type": "string" @@ -5435,6 +5446,23 @@ false "$ref": "StorageDatabasecenterPartnerapiV1mainResourceMaintenanceInfo", "description": "Optional. Maintenance info for the resource." }, +"modes": { +"description": "Optional. The modes of the database resource.", +"items": { +"enum": [ +"MODE_UNSPECIFIED", +"MODE_NATIVE", +"MODE_MONGODB_COMPATIBLE" +], +"enumDescriptions": [ +"Default mode.", +"Native mode.", +"MongoDB compatible mode." +], +"type": "string" +}, +"type": "array" +}, "primaryResourceId": { "$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceId", "description": "Identifier for this resource's immediate parent/primary resource if the current resource is a replica or derived form of another Database resource. Else it would be NULL. REQUIRED if the immediate parent exists when first time resource is getting ingested, otherwise optional." @@ -5892,7 +5920,7 @@ false "type": "object" }, "StorageDatabasecenterPartnerapiV1mainDatabaseResourceSignalData": { -"description": "Database resource signal data. This is used to send signals to Condor which are based on the DB/Instance/Fleet level configurations. These will be used to send signals for all inventory types. Next ID: 9", +"description": "Database resource signal data. This is used to send signals to Condor which are based on the DB/Instance/Fleet level configurations. These will be used to send signals for all inventory types. Next ID: 10", "id": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceSignalData", "properties": { "backupRun": { @@ -5909,6 +5937,10 @@ false "format": "google-datetime", "type": "string" }, +"location": { +"description": "Resource location.", +"type": "string" +}, "resourceId": { "$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceId", "description": "Database resource id." diff --git a/googleapiclient/discovery_cache/documents/alloydb.v1alpha.json b/googleapiclient/discovery_cache/documents/alloydb.v1alpha.json index 378c8d22bd..197dd3f8ce 100644 --- a/googleapiclient/discovery_cache/documents/alloydb.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/alloydb.v1alpha.json @@ -357,7 +357,7 @@ ] }, "list": { -"description": "Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.", +"description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "flatPath": "v1alpha/projects/{projectsId}/locations", "httpMethod": "GET", "id": "alloydb.projects.locations.list", @@ -1691,6 +1691,213 @@ } } }, +"endpoints": { +"methods": { +"create": { +"description": "Creates a new Endpoint in a given project and location.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/endpoints", +"httpMethod": "POST", +"id": "alloydb.projects.locations.endpoints.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"endpointId": { +"description": "Required. ID of the requesting object.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The location of the new endpoint. For the required format, see the comment on the Endpoint.name field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +}, +"requestId": { +"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"validateOnly": { +"description": "Optional. If set, the backend validates the request, but doesn't actually execute it.", +"location": "query", +"type": "boolean" +} +}, +"path": "v1alpha/{+parent}/endpoints", +"request": { +"$ref": "Endpoint" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a single Endpoint.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}", +"httpMethod": "DELETE", +"id": "alloydb.projects.locations.endpoints.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"etag": { +"description": "Optional. The current etag of the Endpoint. If an etag is provided and does not match the current etag of the Endpoint, deletion will be blocked and an ABORTED error will be returned.", +"location": "query", +"type": "string" +}, +"name": { +"description": "Required. The name of the resource. For the required format, see the comment on the Endpoint.name field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", +"required": true, +"type": "string" +}, +"requestId": { +"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"validateOnly": { +"description": "Optional. If set, the backend validates the request, but doesn't actually execute it.", +"location": "query", +"type": "boolean" +} +}, +"path": "v1alpha/{+name}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets details of a single Endpoint.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}", +"httpMethod": "GET", +"id": "alloydb.projects.locations.endpoints.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the resource. For the required format, see the comment on the Endpoint.name field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"response": { +"$ref": "Endpoint" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists Endpoints in a given project and location.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/endpoints", +"httpMethod": "GET", +"id": "alloydb.projects.locations.endpoints.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. Filtering results. This field is currently not supported, its value will be ignored if passed.", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Optional. Hint for how to order the results", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A page token, received from a previous `ListEndpoints` call. This should be provided to retrieve the subsequent page. This field is currently not supported, its value will be ignored if passed.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The name of the parent resource. For the required format, see the comment on the Endpoint.name field. Additionally, you can perform an aggregated list operation by specifying a value with the following format: * projects/{project}/locations/-", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+parent}/endpoints", +"response": { +"$ref": "ListEndpointsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Updates the parameters of a single Endpoint.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}", +"httpMethod": "PATCH", +"id": "alloydb.projects.locations.endpoints.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"allowMissing": { +"description": "Optional. If set to true, update succeeds even if endpoint is not found. In that case, a new endpoint is created and `update_mask` is ignored.", +"location": "query", +"type": "boolean" +}, +"name": { +"description": "Output only. Identifier. The name of the endpoint resource with the format: * projects/{project}/locations/{region}/endpoints/{endpoint_id} where the endpoint ID segment should satisfy the regex expression `[a-z0-9-]+`. For more details see https://google.aip.dev/122. The prefix of the endpoint resource name is the name of the parent resource: * projects/{project}/locations/{region}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", +"required": true, +"type": "string" +}, +"requestId": { +"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"updateMask": { +"description": "Optional. Field mask is used to specify the fields to be overwritten in the Endpoint resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +}, +"validateOnly": { +"description": "Optional. If set, the backend validates the request, but doesn't actually execute it.", +"location": "query", +"type": "boolean" +} +}, +"path": "v1alpha/{+name}", +"request": { +"$ref": "Endpoint" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, "operations": { "methods": { "cancel": { @@ -1879,7 +2086,7 @@ } } }, -"revision": "20260226", +"revision": "20260326", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AuthorizedNetwork": { @@ -2562,7 +2769,8 @@ false "BOOTSTRAPPING", "MAINTENANCE", "PROMOTING", -"SWITCHOVER" +"SWITCHOVER", +"RECREATING" ], "enumDescriptions": [ "The state of the cluster is unknown.", @@ -2575,7 +2783,8 @@ false "The cluster is bootstrapping with data from some other source. Direct mutations to the cluster (e.g. adding read pool) are not allowed.", "The cluster is under maintenance. AlloyDB regularly performs maintenance and upgrades on customer clusters. Updates on the cluster are not allowed while the cluster is in this state.", "The cluster is being promoted.", -"The cluster has entered switchover state. All updates on cluster and its associated instances are restricted while the cluster is in this state." +"The cluster has entered switchover state. All updates on cluster and its associated instances are restricted while the cluster is in this state.", +"The cluster is being recreated." ], "readOnly": true, "type": "string" @@ -2931,6 +3140,21 @@ false }, "type": "object" }, +"DNSConfig": { +"description": "The DNS config for the endpoint, containing the DNS record name, type and targets.", +"id": "DNSConfig", +"properties": { +"dnsName": { +"description": "The fully qualified domain name (FQDN) of the DNS record, e.g., \".location.alloydb-psa.goog\".", +"type": "string" +}, +"dnsRecordType": { +"description": "The type of the DNS record, e.g., \"A\", \"AAAA\", \"CNAME\".", +"type": "string" +} +}, +"type": "object" +}, "DataplexConfig": { "description": "Configuration for Dataplex integration.", "id": "DataplexConfig", @@ -3008,6 +3232,114 @@ false }, "type": "object" }, +"Endpoint": { +"description": "Endpoint resource.", +"id": "Endpoint", +"properties": { +"annotations": { +"additionalProperties": { +"type": "string" +}, +"description": "Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128", +"type": "object" +}, +"createTime": { +"description": "Output only. Create time stamp", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"deleteTime": { +"description": "Output only. Delete time stamp", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"displayName": { +"description": "User-settable and human-readable display name for the Endpoint.", +"type": "string" +}, +"dnsConfig": { +"$ref": "DNSConfig", +"description": "Output only. The DNS config for the endpoint. Each endpoint is associated with a specific DNS name and the DNS type. The DNS targets are the IP addresses of the target instances. The dns_type is the type of the DNS record, eg. Type \"A\" or Type \"CNAME\". This field is not configurable by the user, and it is updated when user specifies the target instances.", +"readOnly": true +}, +"effectiveTargetInstances": { +"description": "Output only. The effective target instances that the endpoint is associated with. This is a list of target instance names, e.g. projects/{project_number}/locations/{location}/clusters/{cluster_id}/instances/{instance_id} For write endpoint, there is only one effective target instance which has to be a primary instance. Effective target instances are only different from target instances after a switchover or cross-region failover operation. Otherwise, effective_target_instances are the same as target_instances. Note that after a cross-region failover operation, the effective_target_instances can be stale until the operation to update the endpoint is complete.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"endpointType": { +"description": "The type of the endpoint, either write or read.", +"enum": [ +"ENDPOINT_TYPE_UNSPECIFIED", +"WRITE_ENDPOINT", +"READ_ENDPOINT" +], +"enumDescriptions": [ +"Unspecified endpoint type", +"Write endpoint, which is associated with a primary instance.", +"Read endpoint, which is associated with read or secondary instances." +], +"type": "string" +}, +"etag": { +"description": "For Resource freshness validation (https://google.aip.dev/154)", +"type": "string" +}, +"name": { +"description": "Output only. Identifier. The name of the endpoint resource with the format: * projects/{project}/locations/{region}/endpoints/{endpoint_id} where the endpoint ID segment should satisfy the regex expression `[a-z0-9-]+`. For more details see https://google.aip.dev/122. The prefix of the endpoint resource name is the name of the parent resource: * projects/{project}/locations/{region}", +"readOnly": true, +"type": "string" +}, +"reconciling": { +"description": "Output only. Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of Endpoint does not match the user's intended state, and the service is actively updating the Endpoint to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance.", +"readOnly": true, +"type": "boolean" +}, +"state": { +"description": "Output only. The state of the endpoint.", +"enum": [ +"STATE_UNSPECIFIED", +"READY", +"CREATING", +"UPDATING", +"DELETING" +], +"enumDescriptions": [ +"Unspecified state", +"The endpoint is active and ready to use.", +"The endpoint is being created.", +"The endpoint is being updated.", +"The endpoint is being deleted." +], +"readOnly": true, +"type": "string" +}, +"targetInstances": { +"description": "The names of the target instances for the endpoint, should be of format projects/{project}/locations/{region}/clusters/{cluster}/instances/{instance}. For write endpoint, there is only one target instance which has to be a primary instance. For read endpoint, there can be multiple target instances which can be read or secondary instances. After a cross-region failover or switchover operation, the endpoint will be associated with a different target instance. This change will be reflected in the effective_target_instances field.", +"items": { +"type": "string" +}, +"type": "array" +}, +"uid": { +"description": "Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.", +"readOnly": true, +"type": "string" +}, +"updateTime": { +"description": "Output only. Update time stamp", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "ExportClusterRequest": { "description": "Export cluster request.", "id": "ExportClusterRequest", @@ -3663,6 +3995,31 @@ false }, "type": "object" }, +"ListEndpointsResponse": { +"description": "Message for response to listing Endpoints", +"id": "ListEndpointsResponse", +"properties": { +"endpoints": { +"description": "The list of Endpoints", +"items": { +"$ref": "Endpoint" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token identifying a page of results the server should return.", +"type": "string" +}, +"unreachable": { +"description": "Locations that could not be reached.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "ListInstancesResponse": { "description": "Message for response to listing Instances", "id": "ListInstancesResponse", @@ -3900,6 +4257,11 @@ false "readOnly": true, "type": "string" }, +"isHotStandby": { +"description": "Output only. Indicates whether the node set up to be configured as a hot standby.", +"readOnly": true, +"type": "boolean" +}, "state": { "description": "Output only. Determined by state of the compute VM and postgres-service health. Compute VM state can have values listed in https://cloud.google.com/compute/docs/instances/instance-life-cycle and postgres-service health can have values: HEALTHY and UNHEALTHY.", "readOnly": true, @@ -4099,6 +4461,10 @@ false "description": "Optional. The current etag of the Cluster. If an etag is provided and does not match the current etag of the Cluster, deletion will be blocked and an ABORTED error will be returned.", "type": "string" }, +"failover": { +"description": "Optional. If set, the promote operation will attempt to recreate the original primary cluster as a secondary cluster when it comes back online. Otherwise, the promoted cluster will be a standalone cluster. Currently only supported when there is a single secondary cluster.", +"type": "boolean" +}, "requestId": { "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "type": "string" @@ -5458,7 +5824,7 @@ false "type": "object" }, "StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata": { -"description": "Common model for database resource instance metadata. Next ID: 31", +"description": "Common model for database resource instance metadata. Next ID: 32", "id": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata", "properties": { "availabilityConfiguration": { @@ -5576,6 +5942,8 @@ false "SUB_RESOURCE_TYPE_READ_REPLICA", "SUB_RESOURCE_TYPE_EXTERNAL_PRIMARY", "SUB_RESOURCE_TYPE_READ_POOL", +"SUB_RESOURCE_TYPE_RESERVATION", +"SUB_RESOURCE_TYPE_DATASET", "SUB_RESOURCE_TYPE_OTHER" ], "enumDeprecated": [ @@ -5590,6 +5958,8 @@ false, false, false, false, +false, +false, false ], "enumDescriptions": [ @@ -5604,6 +5974,8 @@ false "An instance acting as a read-replica.", "An instance acting as an external primary.", "An instance acting as Read Pool.", +"Represents a reservation resource.", +"Represents a dataset resource.", "For rest of the other categories." ], "type": "string" @@ -5624,6 +5996,23 @@ false "$ref": "StorageDatabasecenterPartnerapiV1mainResourceMaintenanceInfo", "description": "Optional. Maintenance info for the resource." }, +"modes": { +"description": "Optional. The modes of the database resource.", +"items": { +"enum": [ +"MODE_UNSPECIFIED", +"MODE_NATIVE", +"MODE_MONGODB_COMPATIBLE" +], +"enumDescriptions": [ +"Default mode.", +"Native mode.", +"MongoDB compatible mode." +], +"type": "string" +}, +"type": "array" +}, "primaryResourceId": { "$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceId", "description": "Identifier for this resource's immediate parent/primary resource if the current resource is a replica or derived form of another Database resource. Else it would be NULL. REQUIRED if the immediate parent exists when first time resource is getting ingested, otherwise optional." @@ -6081,7 +6470,7 @@ false "type": "object" }, "StorageDatabasecenterPartnerapiV1mainDatabaseResourceSignalData": { -"description": "Database resource signal data. This is used to send signals to Condor which are based on the DB/Instance/Fleet level configurations. These will be used to send signals for all inventory types. Next ID: 9", +"description": "Database resource signal data. This is used to send signals to Condor which are based on the DB/Instance/Fleet level configurations. These will be used to send signals for all inventory types. Next ID: 10", "id": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceSignalData", "properties": { "backupRun": { @@ -6098,6 +6487,10 @@ false "format": "google-datetime", "type": "string" }, +"location": { +"description": "Resource location.", +"type": "string" +}, "resourceId": { "$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceId", "description": "Database resource id." diff --git a/googleapiclient/discovery_cache/documents/alloydb.v1beta.json b/googleapiclient/discovery_cache/documents/alloydb.v1beta.json index 69753507c1..1c725b7bf9 100644 --- a/googleapiclient/discovery_cache/documents/alloydb.v1beta.json +++ b/googleapiclient/discovery_cache/documents/alloydb.v1beta.json @@ -357,7 +357,7 @@ ] }, "list": { -"description": "Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.", +"description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "flatPath": "v1beta/projects/{projectsId}/locations", "httpMethod": "GET", "id": "alloydb.projects.locations.list", @@ -1691,6 +1691,213 @@ } } }, +"endpoints": { +"methods": { +"create": { +"description": "Creates a new Endpoint in a given project and location.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/endpoints", +"httpMethod": "POST", +"id": "alloydb.projects.locations.endpoints.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"endpointId": { +"description": "Required. ID of the requesting object.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The location of the new endpoint. For the required format, see the comment on the Endpoint.name field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +}, +"requestId": { +"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"validateOnly": { +"description": "Optional. If set, the backend validates the request, but doesn't actually execute it.", +"location": "query", +"type": "boolean" +} +}, +"path": "v1beta/{+parent}/endpoints", +"request": { +"$ref": "Endpoint" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a single Endpoint.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}", +"httpMethod": "DELETE", +"id": "alloydb.projects.locations.endpoints.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"etag": { +"description": "Optional. The current etag of the Endpoint. If an etag is provided and does not match the current etag of the Endpoint, deletion will be blocked and an ABORTED error will be returned.", +"location": "query", +"type": "string" +}, +"name": { +"description": "Required. The name of the resource. For the required format, see the comment on the Endpoint.name field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", +"required": true, +"type": "string" +}, +"requestId": { +"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"validateOnly": { +"description": "Optional. If set, the backend validates the request, but doesn't actually execute it.", +"location": "query", +"type": "boolean" +} +}, +"path": "v1beta/{+name}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets details of a single Endpoint.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}", +"httpMethod": "GET", +"id": "alloydb.projects.locations.endpoints.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the resource. For the required format, see the comment on the Endpoint.name field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+name}", +"response": { +"$ref": "Endpoint" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists Endpoints in a given project and location.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/endpoints", +"httpMethod": "GET", +"id": "alloydb.projects.locations.endpoints.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. Filtering results. This field is currently not supported, its value will be ignored if passed.", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Optional. Hint for how to order the results", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A page token, received from a previous `ListEndpoints` call. This should be provided to retrieve the subsequent page. This field is currently not supported, its value will be ignored if passed.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The name of the parent resource. For the required format, see the comment on the Endpoint.name field. Additionally, you can perform an aggregated list operation by specifying a value with the following format: * projects/{project}/locations/-", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+parent}/endpoints", +"response": { +"$ref": "ListEndpointsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Updates the parameters of a single Endpoint.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}", +"httpMethod": "PATCH", +"id": "alloydb.projects.locations.endpoints.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"allowMissing": { +"description": "Optional. If set to true, update succeeds even if endpoint is not found. In that case, a new endpoint is created and `update_mask` is ignored.", +"location": "query", +"type": "boolean" +}, +"name": { +"description": "Output only. Identifier. The name of the endpoint resource with the format: * projects/{project}/locations/{region}/endpoints/{endpoint_id} where the endpoint ID segment should satisfy the regex expression `[a-z0-9-]+`. For more details see https://google.aip.dev/122. The prefix of the endpoint resource name is the name of the parent resource: * projects/{project}/locations/{region}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", +"required": true, +"type": "string" +}, +"requestId": { +"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"updateMask": { +"description": "Optional. Field mask is used to specify the fields to be overwritten in the Endpoint resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +}, +"validateOnly": { +"description": "Optional. If set, the backend validates the request, but doesn't actually execute it.", +"location": "query", +"type": "boolean" +} +}, +"path": "v1beta/{+name}", +"request": { +"$ref": "Endpoint" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, "operations": { "methods": { "cancel": { @@ -1876,7 +2083,7 @@ } } }, -"revision": "20260226", +"revision": "20260326", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AuthorizedNetwork": { @@ -2543,7 +2750,8 @@ false "BOOTSTRAPPING", "MAINTENANCE", "PROMOTING", -"SWITCHOVER" +"SWITCHOVER", +"RECREATING" ], "enumDescriptions": [ "The state of the cluster is unknown.", @@ -2556,7 +2764,8 @@ false "The cluster is bootstrapping with data from some other source. Direct mutations to the cluster (e.g. adding read pool) are not allowed.", "The cluster is under maintenance. AlloyDB regularly performs maintenance and upgrades on customer clusters. Updates on the cluster are not allowed while the cluster is in this state.", "The cluster is being promoted.", -"The cluster has entered switchover state. All updates on cluster and its associated instances are restricted while the cluster is in this state." +"The cluster has entered switchover state. All updates on cluster and its associated instances are restricted while the cluster is in this state.", +"The cluster is being recreated." ], "readOnly": true, "type": "string" @@ -2912,6 +3121,21 @@ false }, "type": "object" }, +"DNSConfig": { +"description": "The DNS config for the endpoint, containing the DNS record name, type and targets.", +"id": "DNSConfig", +"properties": { +"dnsName": { +"description": "The fully qualified domain name (FQDN) of the DNS record, e.g., \".location.alloydb-psa.goog\".", +"type": "string" +}, +"dnsRecordType": { +"description": "The type of the DNS record, e.g., \"A\", \"AAAA\", \"CNAME\".", +"type": "string" +} +}, +"type": "object" +}, "DataplexConfig": { "description": "Configuration for Dataplex integration.", "id": "DataplexConfig", @@ -2989,6 +3213,114 @@ false }, "type": "object" }, +"Endpoint": { +"description": "Endpoint resource.", +"id": "Endpoint", +"properties": { +"annotations": { +"additionalProperties": { +"type": "string" +}, +"description": "Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128", +"type": "object" +}, +"createTime": { +"description": "Output only. Create time stamp", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"deleteTime": { +"description": "Output only. Delete time stamp", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"displayName": { +"description": "User-settable and human-readable display name for the Endpoint.", +"type": "string" +}, +"dnsConfig": { +"$ref": "DNSConfig", +"description": "Output only. The DNS config for the endpoint. Each endpoint is associated with a specific DNS name and the DNS type. The DNS targets are the IP addresses of the target instances. The dns_type is the type of the DNS record, eg. Type \"A\" or Type \"CNAME\". This field is not configurable by the user, and it is updated when user specifies the target instances.", +"readOnly": true +}, +"effectiveTargetInstances": { +"description": "Output only. The effective target instances that the endpoint is associated with. This is a list of target instance names, e.g. projects/{project_number}/locations/{location}/clusters/{cluster_id}/instances/{instance_id} For write endpoint, there is only one effective target instance which has to be a primary instance. Effective target instances are only different from target instances after a switchover or cross-region failover operation. Otherwise, effective_target_instances are the same as target_instances. Note that after a cross-region failover operation, the effective_target_instances can be stale until the operation to update the endpoint is complete.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"endpointType": { +"description": "The type of the endpoint, either write or read.", +"enum": [ +"ENDPOINT_TYPE_UNSPECIFIED", +"WRITE_ENDPOINT", +"READ_ENDPOINT" +], +"enumDescriptions": [ +"Unspecified endpoint type", +"Write endpoint, which is associated with a primary instance.", +"Read endpoint, which is associated with read or secondary instances." +], +"type": "string" +}, +"etag": { +"description": "For Resource freshness validation (https://google.aip.dev/154)", +"type": "string" +}, +"name": { +"description": "Output only. Identifier. The name of the endpoint resource with the format: * projects/{project}/locations/{region}/endpoints/{endpoint_id} where the endpoint ID segment should satisfy the regex expression `[a-z0-9-]+`. For more details see https://google.aip.dev/122. The prefix of the endpoint resource name is the name of the parent resource: * projects/{project}/locations/{region}", +"readOnly": true, +"type": "string" +}, +"reconciling": { +"description": "Output only. Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of Endpoint does not match the user's intended state, and the service is actively updating the Endpoint to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance.", +"readOnly": true, +"type": "boolean" +}, +"state": { +"description": "Output only. The state of the endpoint.", +"enum": [ +"STATE_UNSPECIFIED", +"READY", +"CREATING", +"UPDATING", +"DELETING" +], +"enumDescriptions": [ +"Unspecified state", +"The endpoint is active and ready to use.", +"The endpoint is being created.", +"The endpoint is being updated.", +"The endpoint is being deleted." +], +"readOnly": true, +"type": "string" +}, +"targetInstances": { +"description": "The names of the target instances for the endpoint, should be of format projects/{project}/locations/{region}/clusters/{cluster}/instances/{instance}. For write endpoint, there is only one target instance which has to be a primary instance. For read endpoint, there can be multiple target instances which can be read or secondary instances. After a cross-region failover or switchover operation, the endpoint will be associated with a different target instance. This change will be reflected in the effective_target_instances field.", +"items": { +"type": "string" +}, +"type": "array" +}, +"uid": { +"description": "Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.", +"readOnly": true, +"type": "string" +}, +"updateTime": { +"description": "Output only. Update time stamp", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "ExportClusterRequest": { "description": "Export cluster request.", "id": "ExportClusterRequest", @@ -3639,6 +3971,31 @@ false }, "type": "object" }, +"ListEndpointsResponse": { +"description": "Message for response to listing Endpoints", +"id": "ListEndpointsResponse", +"properties": { +"endpoints": { +"description": "The list of Endpoints", +"items": { +"$ref": "Endpoint" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token identifying a page of results the server should return.", +"type": "string" +}, +"unreachable": { +"description": "Locations that could not be reached.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "ListInstancesResponse": { "description": "Message for response to listing Instances", "id": "ListInstancesResponse", @@ -3876,6 +4233,11 @@ false "readOnly": true, "type": "string" }, +"isHotStandby": { +"description": "Output only. Indicates whether the node set up to be configured as a hot standby.", +"readOnly": true, +"type": "boolean" +}, "state": { "description": "Output only. Determined by state of the compute VM and postgres-service health. Compute VM state can have values listed in https://cloud.google.com/compute/docs/instances/instance-life-cycle and postgres-service health can have values: HEALTHY and UNHEALTHY.", "readOnly": true, @@ -4075,6 +4437,10 @@ false "description": "Optional. The current etag of the Cluster. If an etag is provided and does not match the current etag of the Cluster, deletion will be blocked and an ABORTED error will be returned.", "type": "string" }, +"failover": { +"description": "Optional. If set, the promote operation will attempt to recreate the original primary cluster as a secondary cluster when it comes back online. Otherwise, the promoted cluster will be a standalone cluster. Currently only supported when there is a single secondary cluster.", +"type": "boolean" +}, "requestId": { "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "type": "string" @@ -5434,7 +5800,7 @@ false "type": "object" }, "StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata": { -"description": "Common model for database resource instance metadata. Next ID: 31", +"description": "Common model for database resource instance metadata. Next ID: 32", "id": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata", "properties": { "availabilityConfiguration": { @@ -5552,6 +5918,8 @@ false "SUB_RESOURCE_TYPE_READ_REPLICA", "SUB_RESOURCE_TYPE_EXTERNAL_PRIMARY", "SUB_RESOURCE_TYPE_READ_POOL", +"SUB_RESOURCE_TYPE_RESERVATION", +"SUB_RESOURCE_TYPE_DATASET", "SUB_RESOURCE_TYPE_OTHER" ], "enumDeprecated": [ @@ -5566,6 +5934,8 @@ false, false, false, false, +false, +false, false ], "enumDescriptions": [ @@ -5580,6 +5950,8 @@ false "An instance acting as a read-replica.", "An instance acting as an external primary.", "An instance acting as Read Pool.", +"Represents a reservation resource.", +"Represents a dataset resource.", "For rest of the other categories." ], "type": "string" @@ -5600,6 +5972,23 @@ false "$ref": "StorageDatabasecenterPartnerapiV1mainResourceMaintenanceInfo", "description": "Optional. Maintenance info for the resource." }, +"modes": { +"description": "Optional. The modes of the database resource.", +"items": { +"enum": [ +"MODE_UNSPECIFIED", +"MODE_NATIVE", +"MODE_MONGODB_COMPATIBLE" +], +"enumDescriptions": [ +"Default mode.", +"Native mode.", +"MongoDB compatible mode." +], +"type": "string" +}, +"type": "array" +}, "primaryResourceId": { "$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceId", "description": "Identifier for this resource's immediate parent/primary resource if the current resource is a replica or derived form of another Database resource. Else it would be NULL. REQUIRED if the immediate parent exists when first time resource is getting ingested, otherwise optional." @@ -6057,7 +6446,7 @@ false "type": "object" }, "StorageDatabasecenterPartnerapiV1mainDatabaseResourceSignalData": { -"description": "Database resource signal data. This is used to send signals to Condor which are based on the DB/Instance/Fleet level configurations. These will be used to send signals for all inventory types. Next ID: 9", +"description": "Database resource signal data. This is used to send signals to Condor which are based on the DB/Instance/Fleet level configurations. These will be used to send signals for all inventory types. Next ID: 10", "id": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceSignalData", "properties": { "backupRun": { @@ -6074,6 +6463,10 @@ false "format": "google-datetime", "type": "string" }, +"location": { +"description": "Resource location.", +"type": "string" +}, "resourceId": { "$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceId", "description": "Database resource id." diff --git a/googleapiclient/discovery_cache/documents/analyticsadmin.v1alpha.json b/googleapiclient/discovery_cache/documents/analyticsadmin.v1alpha.json index 31f8014cc7..043264a604 100644 --- a/googleapiclient/discovery_cache/documents/analyticsadmin.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/analyticsadmin.v1alpha.json @@ -124,13 +124,13 @@ "parameterOrder": [], "parameters": { "pageSize": { -"description": "The maximum number of AccountSummary resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)", +"description": "Optional. The maximum number of AccountSummary resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "A page token, received from a previous `ListAccountSummaries` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccountSummaries` must match the call that provided the page token.", +"description": "Optional. A page token, received from a previous `ListAccountSummaries` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccountSummaries` must match the call that provided the page token.", "location": "query", "type": "string" } @@ -233,13 +233,13 @@ "parameterOrder": [], "parameters": { "pageSize": { -"description": "The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)", +"description": "Optional. The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "A page token, received from a previous `ListAccounts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccounts` must match the call that provided the page token.", +"description": "Optional. A page token, received from a previous `ListAccounts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccounts` must match the call that provided the page token.", "location": "query", "type": "string" }, @@ -268,7 +268,7 @@ ], "parameters": { "name": { -"description": "Output only. Resource name of this account. Format: accounts/{account} Example: \"accounts/100\"", +"description": "Identifier. Resource name of this account. Format: accounts/{account} Example: \"accounts/100\"", "location": "path", "pattern": "^accounts/[^/]+$", "required": true, @@ -869,13 +869,13 @@ "type": "string" }, "pageSize": { -"description": "The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)", +"description": "Optional. The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "A page token, received from a previous `ListProperties` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListProperties` must match the call that provided the page token.", +"description": "Optional. A page token, received from a previous `ListProperties` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListProperties` must match the call that provided the page token.", "location": "query", "type": "string" }, @@ -904,7 +904,7 @@ ], "parameters": { "name": { -"description": "Output only. Resource name of this property. Format: properties/{property_id} Example: \"properties/1000\"", +"description": "Identifier. Resource name of this property. Format: properties/{property_id} Example: \"properties/1000\"", "location": "path", "pattern": "^properties/[^/]+$", "required": true, @@ -1047,7 +1047,7 @@ ], "parameters": { "name": { -"description": "Output only. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings", +"description": "Identifier. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings", "location": "path", "pattern": "^properties/[^/]+/dataRetentionSettings$", "required": true, @@ -1935,7 +1935,7 @@ ], "parameters": { "name": { -"description": "Output only. Resource name for this CalculatedMetric. Format: 'properties/{property_id}/calculatedMetrics/{calculated_metric_id}'", +"description": "Identifier. Resource name for this CalculatedMetric. Format: 'properties/{property_id}/calculatedMetrics/{calculated_metric_id}'", "location": "path", "pattern": "^properties/[^/]+/calculatedMetrics/[^/]+$", "required": true, @@ -2211,13 +2211,13 @@ ], "parameters": { "pageSize": { -"description": "The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)", +"description": "Optional. The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "A page token, received from a previous `ListConversionEvents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListConversionEvents` must match the call that provided the page token.", +"description": "Optional. A page token, received from a previous `ListConversionEvents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListConversionEvents` must match the call that provided the page token.", "location": "query", "type": "string" }, @@ -2249,7 +2249,7 @@ ], "parameters": { "name": { -"description": "Output only. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event}", +"description": "Identifier. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event}", "location": "path", "pattern": "^properties/[^/]+/conversionEvents/[^/]+$", "required": true, @@ -2369,13 +2369,13 @@ ], "parameters": { "pageSize": { -"description": "The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum).", +"description": "Optional. The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum).", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "A page token, received from a previous `ListCustomDimensions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCustomDimensions` must match the call that provided the page token.", +"description": "Optional. A page token, received from a previous `ListCustomDimensions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCustomDimensions` must match the call that provided the page token.", "location": "query", "type": "string" }, @@ -2406,7 +2406,7 @@ ], "parameters": { "name": { -"description": "Output only. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension}", +"description": "Identifier. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension}", "location": "path", "pattern": "^properties/[^/]+/customDimensions/[^/]+$", "required": true, @@ -2563,7 +2563,7 @@ ], "parameters": { "name": { -"description": "Output only. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric}", +"description": "Identifier. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric}", "location": "path", "pattern": "^properties/[^/]+/customMetrics/[^/]+$", "required": true, @@ -2795,7 +2795,7 @@ ], "parameters": { "name": { -"description": "Output only. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: \"properties/1000/dataStreams/2000\"", +"description": "Identifier. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: \"properties/1000/dataStreams/2000\"", "location": "path", "pattern": "^properties/[^/]+/dataStreams/[^/]+$", "required": true, @@ -3316,13 +3316,13 @@ ], "parameters": { "pageSize": { -"description": "The maximum number of resources to return. If unspecified, at most 10 resources will be returned. The maximum value is 10. Higher values will be coerced to the maximum.", +"description": "Optional. The maximum number of resources to return. If unspecified, at most 10 resources will be returned. The maximum value is 10. Higher values will be coerced to the maximum.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "A page token, received from a previous `ListMeasurementProtocolSecrets` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListMeasurementProtocolSecrets` must match the call that provided the page token.", +"description": "Optional. A page token, received from a previous `ListMeasurementProtocolSecrets` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListMeasurementProtocolSecrets` must match the call that provided the page token.", "location": "query", "type": "string" }, @@ -3353,7 +3353,7 @@ ], "parameters": { "name": { -"description": "Output only. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}", +"description": "Identifier. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}", "location": "path", "pattern": "^properties/[^/]+/dataStreams/[^/]+/measurementProtocolSecrets/[^/]+$", "required": true, @@ -3470,13 +3470,13 @@ ], "parameters": { "pageSize": { -"description": "The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)", +"description": "Optional. The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "A page token, received from a previous `ListSKAdNetworkConversionValueSchemas` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSKAdNetworkConversionValueSchema` must match the call that provided the page token.", +"description": "Optional. A page token, received from a previous `ListSKAdNetworkConversionValueSchemas` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSKAdNetworkConversionValueSchema` must match the call that provided the page token.", "location": "query", "type": "string" }, @@ -3507,7 +3507,7 @@ ], "parameters": { "name": { -"description": "Output only. Resource name of the schema. This will be child of ONLY an iOS stream, and there can be at most one such child under an iOS stream. Format: properties/{property}/dataStreams/{dataStream}/sKAdNetworkConversionValueSchema", +"description": "Identifier. Resource name of the schema. This will be child of ONLY an iOS stream, and there can be at most one such child under an iOS stream. Format: properties/{property}/dataStreams/{dataStream}/sKAdNetworkConversionValueSchema", "location": "path", "pattern": "^properties/[^/]+/dataStreams/[^/]+/sKAdNetworkConversionValueSchema/[^/]+$", "required": true, @@ -3839,7 +3839,7 @@ ], "parameters": { "name": { -"description": "Output only. The resource name for this DisplayVideo360AdvertiserLink resource. Format: properties/{propertyId}/displayVideo360AdvertiserLinks/{linkId} Note: linkId is not the Display & Video 360 Advertiser ID", +"description": "Identifier. The resource name for this DisplayVideo360AdvertiserLink resource. Format: properties/{propertyId}/displayVideo360AdvertiserLinks/{linkId} Note: linkId is not the Display & Video 360 Advertiser ID", "location": "path", "pattern": "^properties/[^/]+/displayVideo360AdvertiserLinks/[^/]+$", "required": true, @@ -4084,13 +4084,13 @@ ], "parameters": { "pageSize": { -"description": "The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)", +"description": "Optional. The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "A page token, received from a previous `ListFirebaseLinks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListFirebaseLinks` must match the call that provided the page token.", +"description": "Optional. A page token, received from a previous `ListFirebaseLinks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListFirebaseLinks` must match the call that provided the page token.", "location": "query", "type": "string" }, @@ -4178,13 +4178,13 @@ ], "parameters": { "pageSize": { -"description": "The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum).", +"description": "Optional. The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum).", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "A page token, received from a previous `ListGoogleAdsLinks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListGoogleAdsLinks` must match the call that provided the page token.", +"description": "Optional. A page token, received from a previous `ListGoogleAdsLinks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListGoogleAdsLinks` must match the call that provided the page token.", "location": "query", "type": "string" }, @@ -4215,7 +4215,7 @@ ], "parameters": { "name": { -"description": "Output only. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID.", +"description": "Identifier. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID.", "location": "path", "pattern": "^properties/[^/]+/googleAdsLinks/[^/]+$", "required": true, @@ -4332,13 +4332,13 @@ ], "parameters": { "pageSize": { -"description": "The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)", +"description": "Optional. The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "A page token, received from a previous `ListKeyEvents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListKeyEvents` must match the call that provided the page token.", +"description": "Optional. A page token, received from a previous `ListKeyEvents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListKeyEvents` must match the call that provided the page token.", "location": "query", "type": "string" }, @@ -4802,7 +4802,7 @@ ], "parameters": { "name": { -"description": "Output only. The resource name for this SearchAds360Link resource. Format: properties/{propertyId}/searchAds360Links/{linkId} Note: linkId is not the Search Ads 360 advertiser ID", +"description": "Identifier. The resource name for this SearchAds360Link resource. Format: properties/{propertyId}/searchAds360Links/{linkId} Note: linkId is not the Search Ads 360 advertiser ID", "location": "path", "pattern": "^properties/[^/]+/searchAds360Links/[^/]+$", "required": true, @@ -5086,7 +5086,7 @@ } } }, -"revision": "20250820", +"revision": "20260331", "rootUrl": "https://analyticsadmin.googleapis.com/", "schemas": { "GoogleAnalyticsAdminV1alphaAccessBetweenFilter": { @@ -5505,8 +5505,7 @@ "type": "string" }, "name": { -"description": "Output only. Resource name of this account. Format: accounts/{account} Example: \"accounts/100\"", -"readOnly": true, +"description": "Identifier. Resource name of this account. Format: accounts/{account} Example: \"accounts/100\"", "type": "string" }, "regionCode": { @@ -5535,7 +5534,7 @@ "type": "string" }, "name": { -"description": "Resource name for this account summary. Format: accountSummaries/{account_id} Example: \"accountSummaries/1000\"", +"description": "Identifier. Resource name for this account summary. Format: accountSummaries/{account_id} Example: \"accountSummaries/1000\"", "type": "string" }, "propertySummaries": { @@ -6304,8 +6303,7 @@ "type": "string" }, "name": { -"description": "Output only. Resource name for this CalculatedMetric. Format: 'properties/{property_id}/calculatedMetrics/{calculated_metric_id}'", -"readOnly": true, +"description": "Identifier. Resource name for this CalculatedMetric. Format: 'properties/{property_id}/calculatedMetrics/{calculated_metric_id}'", "type": "string" }, "restrictedMetricType": { @@ -6722,8 +6720,7 @@ "type": "string" }, "name": { -"description": "Output only. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event}", -"readOnly": true, +"description": "Identifier. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event}", "type": "string" } }, @@ -6856,8 +6853,7 @@ "type": "string" }, "name": { -"description": "Output only. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension}", -"readOnly": true, +"description": "Identifier. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension}", "type": "string" }, "parameterName": { @@ -6926,8 +6922,7 @@ "type": "string" }, "name": { -"description": "Output only. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric}", -"readOnly": true, +"description": "Identifier. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric}", "type": "string" }, "parameterName": { @@ -7018,8 +7013,7 @@ "type": "string" }, "name": { -"description": "Output only. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings", -"readOnly": true, +"description": "Identifier. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings", "type": "string" }, "resetUserDataOnNewActivity": { @@ -7054,8 +7048,7 @@ "id": "GoogleAnalyticsAdminV1alphaDataSharingSettings", "properties": { "name": { -"description": "Output only. Resource name. Format: accounts/{account}/dataSharingSettings Example: \"accounts/1000/dataSharingSettings\"", -"readOnly": true, +"description": "Identifier. Resource name. Format: accounts/{account}/dataSharingSettings Example: \"accounts/1000/dataSharingSettings\"", "type": "string" }, "sharingWithGoogleAnySalesEnabled": { @@ -7105,8 +7098,7 @@ "description": "Data specific to iOS app streams. Must be populated if type is IOS_APP_DATA_STREAM." }, "name": { -"description": "Output only. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: \"properties/1000/dataStreams/2000\"", -"readOnly": true, +"description": "Identifier. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: \"properties/1000/dataStreams/2000\"", "type": "string" }, "type": { @@ -7228,8 +7220,7 @@ "type": "boolean" }, "name": { -"description": "Output only. The resource name for this DisplayVideo360AdvertiserLink resource. Format: properties/{propertyId}/displayVideo360AdvertiserLinks/{linkId} Note: linkId is not the Display & Video 360 Advertiser ID", -"readOnly": true, +"description": "Identifier. The resource name for this DisplayVideo360AdvertiserLink resource. Format: properties/{propertyId}/displayVideo360AdvertiserLinks/{linkId} Note: linkId is not the Display & Video 360 Advertiser ID", "type": "string" } }, @@ -7266,8 +7257,7 @@ "readOnly": true }, "name": { -"description": "Output only. The resource name for this DisplayVideo360AdvertiserLinkProposal resource. Format: properties/{propertyId}/displayVideo360AdvertiserLinkProposals/{proposalId} Note: proposalId is not the Display & Video 360 Advertiser ID", -"readOnly": true, +"description": "Identifier. The resource name for this DisplayVideo360AdvertiserLinkProposal resource. Format: properties/{propertyId}/displayVideo360AdvertiserLinkProposals/{proposalId} Note: proposalId is not the Display & Video 360 Advertiser ID", "type": "string" }, "validationEmail": { @@ -7583,8 +7573,7 @@ "type": "string" }, "name": { -"description": "Output only. Example format: properties/1234/firebaseLinks/5678", -"readOnly": true, +"description": "Identifier. Example format: properties/1234/firebaseLinks/5678", "type": "string" }, "project": { @@ -7599,8 +7588,7 @@ "id": "GoogleAnalyticsAdminV1alphaGlobalSiteTag", "properties": { "name": { -"description": "Output only. Resource name for this GlobalSiteTag resource. Format: properties/{property_id}/dataStreams/{stream_id}/globalSiteTag Example: \"properties/123/dataStreams/456/globalSiteTag\"", -"readOnly": true, +"description": "Identifier. Resource name for this GlobalSiteTag resource. Format: properties/{property_id}/dataStreams/{stream_id}/globalSiteTag Example: \"properties/123/dataStreams/456/globalSiteTag\"", "type": "string" }, "snippet": { @@ -7639,8 +7627,7 @@ "type": "string" }, "name": { -"description": "Output only. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID.", -"readOnly": true, +"description": "Identifier. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID.", "type": "string" }, "updateTime": { @@ -8394,8 +8381,7 @@ "type": "string" }, "name": { -"description": "Output only. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}", -"readOnly": true, +"description": "Identifier. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}", "type": "string" }, "secretValue": { @@ -8553,8 +8539,7 @@ "type": "string" }, "name": { -"description": "Output only. Resource name of this property. Format: properties/{property_id} Example: \"properties/1000\"", -"readOnly": true, +"description": "Identifier. Resource name of this property. Format: properties/{property_id} Example: \"properties/1000\"", "type": "string" }, "parent": { @@ -8954,8 +8939,7 @@ "type": "boolean" }, "name": { -"description": "Output only. Resource name of the schema. This will be child of ONLY an iOS stream, and there can be at most one such child under an iOS stream. Format: properties/{property}/dataStreams/{dataStream}/sKAdNetworkConversionValueSchema", -"readOnly": true, +"description": "Identifier. Resource name of the schema. This will be child of ONLY an iOS stream, and there can be at most one such child under an iOS stream. Format: properties/{property}/dataStreams/{dataStream}/sKAdNetworkConversionValueSchema", "type": "string" }, "postbackWindowOne": { @@ -8999,8 +8983,7 @@ "type": "boolean" }, "name": { -"description": "Output only. The resource name for this SearchAds360Link resource. Format: properties/{propertyId}/searchAds360Links/{linkId} Note: linkId is not the Search Ads 360 advertiser ID", -"readOnly": true, +"description": "Identifier. The resource name for this SearchAds360Link resource. Format: properties/{propertyId}/searchAds360Links/{linkId} Note: linkId is not the Search Ads 360 advertiser ID", "type": "string" }, "siteStatsSharingEnabled": { diff --git a/googleapiclient/discovery_cache/documents/analyticsadmin.v1beta.json b/googleapiclient/discovery_cache/documents/analyticsadmin.v1beta.json index e81e5650de..bae869806c 100644 --- a/googleapiclient/discovery_cache/documents/analyticsadmin.v1beta.json +++ b/googleapiclient/discovery_cache/documents/analyticsadmin.v1beta.json @@ -118,13 +118,13 @@ "parameterOrder": [], "parameters": { "pageSize": { -"description": "The maximum number of AccountSummary resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)", +"description": "Optional. The maximum number of AccountSummary resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "A page token, received from a previous `ListAccountSummaries` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccountSummaries` must match the call that provided the page token.", +"description": "Optional. A page token, received from a previous `ListAccountSummaries` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccountSummaries` must match the call that provided the page token.", "location": "query", "type": "string" } @@ -227,13 +227,13 @@ "parameterOrder": [], "parameters": { "pageSize": { -"description": "The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)", +"description": "Optional. The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "A page token, received from a previous `ListAccounts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccounts` must match the call that provided the page token.", +"description": "Optional. A page token, received from a previous `ListAccounts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccounts` must match the call that provided the page token.", "location": "query", "type": "string" }, @@ -262,7 +262,7 @@ ], "parameters": { "name": { -"description": "Output only. Resource name of this account. Format: accounts/{account} Example: \"accounts/100\"", +"description": "Identifier. Resource name of this account. Format: accounts/{account} Example: \"accounts/100\"", "location": "path", "pattern": "^accounts/[^/]+$", "required": true, @@ -501,13 +501,13 @@ "type": "string" }, "pageSize": { -"description": "The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)", +"description": "Optional. The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "A page token, received from a previous `ListProperties` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListProperties` must match the call that provided the page token.", +"description": "Optional. A page token, received from a previous `ListProperties` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListProperties` must match the call that provided the page token.", "location": "query", "type": "string" }, @@ -536,7 +536,7 @@ ], "parameters": { "name": { -"description": "Output only. Resource name of this property. Format: properties/{property_id} Example: \"properties/1000\"", +"description": "Identifier. Resource name of this property. Format: properties/{property_id} Example: \"properties/1000\"", "location": "path", "pattern": "^properties/[^/]+$", "required": true, @@ -599,7 +599,7 @@ ], "parameters": { "name": { -"description": "Output only. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings", +"description": "Identifier. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings", "location": "path", "pattern": "^properties/[^/]+/dataRetentionSettings$", "required": true, @@ -721,13 +721,13 @@ ], "parameters": { "pageSize": { -"description": "The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)", +"description": "Optional. The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "A page token, received from a previous `ListConversionEvents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListConversionEvents` must match the call that provided the page token.", +"description": "Optional. A page token, received from a previous `ListConversionEvents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListConversionEvents` must match the call that provided the page token.", "location": "query", "type": "string" }, @@ -759,7 +759,7 @@ ], "parameters": { "name": { -"description": "Output only. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event}", +"description": "Identifier. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event}", "location": "path", "pattern": "^properties/[^/]+/conversionEvents/[^/]+$", "required": true, @@ -879,13 +879,13 @@ ], "parameters": { "pageSize": { -"description": "The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum).", +"description": "Optional. The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum).", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "A page token, received from a previous `ListCustomDimensions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCustomDimensions` must match the call that provided the page token.", +"description": "Optional. A page token, received from a previous `ListCustomDimensions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCustomDimensions` must match the call that provided the page token.", "location": "query", "type": "string" }, @@ -916,7 +916,7 @@ ], "parameters": { "name": { -"description": "Output only. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension}", +"description": "Identifier. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension}", "location": "path", "pattern": "^properties/[^/]+/customDimensions/[^/]+$", "required": true, @@ -1073,7 +1073,7 @@ ], "parameters": { "name": { -"description": "Output only. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric}", +"description": "Identifier. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric}", "location": "path", "pattern": "^properties/[^/]+/customMetrics/[^/]+$", "required": true, @@ -1227,7 +1227,7 @@ ], "parameters": { "name": { -"description": "Output only. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: \"properties/1000/dataStreams/2000\"", +"description": "Identifier. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: \"properties/1000/dataStreams/2000\"", "location": "path", "pattern": "^properties/[^/]+/dataStreams/[^/]+$", "required": true, @@ -1344,13 +1344,13 @@ ], "parameters": { "pageSize": { -"description": "The maximum number of resources to return. If unspecified, at most 10 resources will be returned. The maximum value is 10. Higher values will be coerced to the maximum.", +"description": "Optional. The maximum number of resources to return. If unspecified, at most 10 resources will be returned. The maximum value is 10. Higher values will be coerced to the maximum.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "A page token, received from a previous `ListMeasurementProtocolSecrets` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListMeasurementProtocolSecrets` must match the call that provided the page token.", +"description": "Optional. A page token, received from a previous `ListMeasurementProtocolSecrets` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListMeasurementProtocolSecrets` must match the call that provided the page token.", "location": "query", "type": "string" }, @@ -1381,7 +1381,7 @@ ], "parameters": { "name": { -"description": "Output only. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}", +"description": "Identifier. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}", "location": "path", "pattern": "^properties/[^/]+/dataStreams/[^/]+/measurementProtocolSecrets/[^/]+$", "required": true, @@ -1474,13 +1474,13 @@ ], "parameters": { "pageSize": { -"description": "The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)", +"description": "Optional. The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "A page token, received from a previous `ListFirebaseLinks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListFirebaseLinks` must match the call that provided the page token.", +"description": "Optional. A page token, received from a previous `ListFirebaseLinks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListFirebaseLinks` must match the call that provided the page token.", "location": "query", "type": "string" }, @@ -1568,13 +1568,13 @@ ], "parameters": { "pageSize": { -"description": "The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum).", +"description": "Optional. The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum).", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "A page token, received from a previous `ListGoogleAdsLinks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListGoogleAdsLinks` must match the call that provided the page token.", +"description": "Optional. A page token, received from a previous `ListGoogleAdsLinks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListGoogleAdsLinks` must match the call that provided the page token.", "location": "query", "type": "string" }, @@ -1605,7 +1605,7 @@ ], "parameters": { "name": { -"description": "Output only. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID.", +"description": "Identifier. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID.", "location": "path", "pattern": "^properties/[^/]+/googleAdsLinks/[^/]+$", "required": true, @@ -1722,13 +1722,13 @@ ], "parameters": { "pageSize": { -"description": "The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)", +"description": "Optional. The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "A page token, received from a previous `ListKeyEvents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListKeyEvents` must match the call that provided the page token.", +"description": "Optional. A page token, received from a previous `ListKeyEvents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListKeyEvents` must match the call that provided the page token.", "location": "query", "type": "string" }, @@ -1788,7 +1788,7 @@ } } }, -"revision": "20250307", +"revision": "20260331", "rootUrl": "https://analyticsadmin.googleapis.com/", "schemas": { "GoogleAnalyticsAdminV1betaAccessBetweenFilter": { @@ -2184,8 +2184,7 @@ "type": "string" }, "name": { -"description": "Output only. Resource name of this account. Format: accounts/{account} Example: \"accounts/100\"", -"readOnly": true, +"description": "Identifier. Resource name of this account. Format: accounts/{account} Example: \"accounts/100\"", "type": "string" }, "regionCode": { @@ -2214,7 +2213,7 @@ "type": "string" }, "name": { -"description": "Resource name for this account summary. Format: accountSummaries/{account_id} Example: \"accountSummaries/1000\"", +"description": "Identifier. Resource name for this account summary. Format: accountSummaries/{account_id} Example: \"accountSummaries/1000\"", "type": "string" }, "propertySummaries": { @@ -2420,8 +2419,7 @@ "type": "string" }, "name": { -"description": "Output only. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event}", -"readOnly": true, +"description": "Identifier. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event}", "type": "string" } }, @@ -2460,8 +2458,7 @@ "type": "string" }, "name": { -"description": "Output only. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension}", -"readOnly": true, +"description": "Identifier. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension}", "type": "string" }, "parameterName": { @@ -2530,8 +2527,7 @@ "type": "string" }, "name": { -"description": "Output only. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric}", -"readOnly": true, +"description": "Identifier. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric}", "type": "string" }, "parameterName": { @@ -2595,8 +2591,7 @@ "type": "string" }, "name": { -"description": "Output only. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings", -"readOnly": true, +"description": "Identifier. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings", "type": "string" }, "resetUserDataOnNewActivity": { @@ -2631,8 +2626,7 @@ "id": "GoogleAnalyticsAdminV1betaDataSharingSettings", "properties": { "name": { -"description": "Output only. Resource name. Format: accounts/{account}/dataSharingSettings Example: \"accounts/1000/dataSharingSettings\"", -"readOnly": true, +"description": "Identifier. Resource name. Format: accounts/{account}/dataSharingSettings Example: \"accounts/1000/dataSharingSettings\"", "type": "string" }, "sharingWithGoogleAnySalesEnabled": { @@ -2682,8 +2676,7 @@ "description": "Data specific to iOS app streams. Must be populated if type is IOS_APP_DATA_STREAM." }, "name": { -"description": "Output only. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: \"properties/1000/dataStreams/2000\"", -"readOnly": true, +"description": "Identifier. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: \"properties/1000/dataStreams/2000\"", "type": "string" }, "type": { @@ -2779,8 +2772,7 @@ "type": "string" }, "name": { -"description": "Output only. Example format: properties/1234/firebaseLinks/5678", -"readOnly": true, +"description": "Identifier. Example format: properties/1234/firebaseLinks/5678", "type": "string" }, "project": { @@ -2819,8 +2811,7 @@ "type": "string" }, "name": { -"description": "Output only. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID.", -"readOnly": true, +"description": "Identifier. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID.", "type": "string" }, "updateTime": { @@ -3105,8 +3096,7 @@ "type": "string" }, "name": { -"description": "Output only. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}", -"readOnly": true, +"description": "Identifier. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}", "type": "string" }, "secretValue": { @@ -3231,8 +3221,7 @@ "type": "string" }, "name": { -"description": "Output only. Resource name of this property. Format: properties/{property_id} Example: \"properties/1000\"", -"readOnly": true, +"description": "Identifier. Resource name of this property. Format: properties/{property_id} Example: \"properties/1000\"", "type": "string" }, "parent": { diff --git a/googleapiclient/discovery_cache/documents/apigateway.v1.json b/googleapiclient/discovery_cache/documents/apigateway.v1.json index 2633ec080c..ab5cc0b95d 100644 --- a/googleapiclient/discovery_cache/documents/apigateway.v1.json +++ b/googleapiclient/discovery_cache/documents/apigateway.v1.json @@ -134,7 +134,7 @@ ] }, "list": { -"description": "Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.", +"description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "flatPath": "v1/projects/{projectsId}/locations", "httpMethod": "GET", "id": "apigateway.projects.locations.list", @@ -1094,7 +1094,7 @@ } } }, -"revision": "20260127", +"revision": "20260325", "rootUrl": "https://apigateway.googleapis.com/", "schemas": { "ApigatewayApi": { diff --git a/googleapiclient/discovery_cache/documents/apigateway.v1beta.json b/googleapiclient/discovery_cache/documents/apigateway.v1beta.json index a971280b78..e9ccfe5eec 100644 --- a/googleapiclient/discovery_cache/documents/apigateway.v1beta.json +++ b/googleapiclient/discovery_cache/documents/apigateway.v1beta.json @@ -134,7 +134,7 @@ ] }, "list": { -"description": "Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.", +"description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "flatPath": "v1beta/projects/{projectsId}/locations", "httpMethod": "GET", "id": "apigateway.projects.locations.list", @@ -1094,7 +1094,7 @@ } } }, -"revision": "20260127", +"revision": "20260325", "rootUrl": "https://apigateway.googleapis.com/", "schemas": { "ApigatewayApi": { diff --git a/googleapiclient/discovery_cache/documents/apigee.v1.json b/googleapiclient/discovery_cache/documents/apigee.v1.json index db52eec259..41dcb1c2f6 100644 --- a/googleapiclient/discovery_cache/documents/apigee.v1.json +++ b/googleapiclient/discovery_cache/documents/apigee.v1.json @@ -30,6 +30,11 @@ "description": "Regional Endpoint", "endpointUrl": "https://apigee.in.rep.googleapis.com/", "location": "in" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://apigee.sa.rep.googleapis.com/", +"location": "sa" } ], "fullyEncodeReservedExpansion": true, @@ -3605,7 +3610,7 @@ "type": "string" }, "expand": { -"description": "Optional. Specifies whether to expand the results. Set to `true` to expand the results. This query parameter is not valid if you use the `count` or `startKey` query parameters.", +"description": "Optional. Specifies whether to expand the results. Set to `true` to expand the results. This query parameter is not valid if you use the `count` or `startKey` query parameters. **Note**: If set to `true`, the `apigee.developerapps.get` permission is required.", "location": "query", "type": "boolean" }, @@ -3617,7 +3622,7 @@ "type": "string" }, "shallowExpand": { -"description": "Optional. Specifies whether to expand the results in shallow mode. Set to `true` to expand the results in shallow mode.", +"description": "Optional. Specifies whether to expand the results in shallow mode. Set to `true` to expand the results in shallow mode. **Note**: If set to `true`, the `apigee.developerapps.get` permission is required.", "location": "query", "type": "boolean" }, @@ -11959,84 +11964,9 @@ } } }, -"revision": "20260218", +"revision": "20260327", "rootUrl": "https://apigee.googleapis.com/", "schemas": { -"ApiservingMcpMcpToolDataHandlingProfile": { -"description": "Profile describing the data handling characteristics of an MCP tool. When used within the McpTool.meta field, this message should be packed into a google.protobuf.Any and associated with the key: \"google.com/tool.profiles/data_handling\"", -"id": "ApiservingMcpMcpToolDataHandlingProfile", -"properties": { -"inputDataAccessLevel": { -"description": "// The data access level of the tool's inputs.", -"enum": [ -"DATA_ACCESS_LEVEL_UNSPECIFIED", -"DATA_ACCESS_LEVEL_PUBLIC", -"DATA_ACCESS_LEVEL_CONFIDENTIAL", -"DATA_ACCESS_LEVEL_NEED_TO_KNOW", -"DATA_ACCESS_LEVEL_PII", -"DATA_ACCESS_LEVEL_USER", -"DATA_ACCESS_LEVEL_NO_DATA_ACCESS" -], -"enumDescriptions": [ -"The default value. This value is unused.", -"Public data.", -"Confidential data.", -"Need-to-know data.", -"Personally Identifiable Information (PII) data.", -"User data.", -"The tool does not access any data." -], -"type": "string" -}, -"outputDataAccessLevel": { -"description": "The data access level of the tool's outputs.", -"enum": [ -"DATA_ACCESS_LEVEL_UNSPECIFIED", -"DATA_ACCESS_LEVEL_PUBLIC", -"DATA_ACCESS_LEVEL_CONFIDENTIAL", -"DATA_ACCESS_LEVEL_NEED_TO_KNOW", -"DATA_ACCESS_LEVEL_PII", -"DATA_ACCESS_LEVEL_USER", -"DATA_ACCESS_LEVEL_NO_DATA_ACCESS" -], -"enumDescriptions": [ -"The default value. This value is unused.", -"Public data.", -"Confidential data.", -"Need-to-know data.", -"Personally Identifiable Information (PII) data.", -"User data.", -"The tool does not access any data." -], -"type": "string" -} -}, -"type": "object" -}, -"ApiservingMcpMcpToolLifecycleProfile": { -"description": "Profile describing the lifecycle stage of an MCP tool. When used within the McpTool.meta field, this message should be packed into a google.protobuf.Any and associated with the key: \"google.com/tool.profiles/lifecycle\"", -"id": "ApiservingMcpMcpToolLifecycleProfile", -"properties": { -"launchState": { -"description": "Output only. The current launch state of the MCP tool.", -"enum": [ -"LAUNCH_STATE_UNSPECIFIED", -"LAUNCH_STATE_DEVELOPMENT", -"LAUNCH_STATE_PRODUCTION_PREVIEW", -"LAUNCH_STATE_GENERAL_AVAILABILITY" -], -"enumDescriptions": [ -"The default value. This value is unused.", -"The tool is currently in development.", -"The tool is in production preview.", -"The tool is generally available." -], -"readOnly": true, -"type": "string" -} -}, -"type": "object" -}, "EdgeConfigstoreBundleBadBundle": { "description": "Describes why a bundle is invalid. Intended for use in error details.", "id": "EdgeConfigstoreBundleBadBundle", @@ -15584,7 +15514,7 @@ "type": "integer" }, "ipHeaderName": { -"description": "Required. The name of the header to extract the client ip from. We are currently only supporting the X-Forwarded-For header.", +"description": "Required. The name of the header to extract the client ip from.", "type": "string" } }, @@ -19195,7 +19125,7 @@ "type": "object" }, "GoogleCloudApigeeV1RuntimeTraceConfig": { -"description": "NEXT ID: 9 RuntimeTraceConfig defines the configurations for distributed trace in an environment.", +"description": "NEXT ID: 10 RuntimeTraceConfig defines the configurations for distributed trace in an environment.", "id": "GoogleCloudApigeeV1RuntimeTraceConfig", "properties": { "endpoint": { @@ -19208,13 +19138,15 @@ "EXPORTER_UNSPECIFIED", "JAEGER", "CLOUD_TRACE", -"OPEN_TELEMETRY_COLLECTOR" +"OPEN_TELEMETRY_COLLECTOR", +"OPEN_TELEMETRY_CLOUD_TRACE" ], "enumDescriptions": [ "Exporter unspecified", -"Jaeger exporter", -"Cloudtrace exporter", -"Open Telemetry Collector" +"Exports events to Jaeger. Compatible with OpenCensus protocol.", +"Exports events to Cloud Trace. Compatible with OpenCensus protocol.", +"OpenTelemetry Collector. Compatible with OpenTelemetry protocol.", +"Exports events to Cloud Trace. Compatible with OpenTelemetry protocol." ], "type": "string" }, @@ -19223,7 +19155,8 @@ "type": "string" }, "openTelemetryProtocolEnabled": { -"description": "If `true`, the runtime uses OpenTelemetry Protocol (OTLP) to send trace data. Configuration Requirements (if `open_telemetry_protocol_enabled` is `true`): - Allowed `Exporter`s: `CLOUD_TRACE` or `OPEN_TELEMETRY_COLLECTOR`. - If `Exporter` is `OPEN_TELEMETRY_COLLECTOR`: - `endpoint` refers to a valid OTLP collector URL. - If `Exporter` is `CLOUD_TRACE`: - `endpoint` refers to a valid project ID", +"deprecated": true, +"description": "Optional. If `true`, the runtime uses OpenTelemetry Protocol (OTLP) to send trace data. Configuration Requirements (if `open_telemetry_protocol_enabled` is `true`): - Allowed `Exporter`s: `CLOUD_TRACE` or `OPEN_TELEMETRY_COLLECTOR`. - If `Exporter` is `OPEN_TELEMETRY_COLLECTOR`: - `endpoint` refers to a valid OTLP collector URL. - If `Exporter` is `CLOUD_TRACE`: - `endpoint` refers to a valid project ID Deprecated: Use trace_protocol instead.", "type": "boolean" }, "overrides": { @@ -19245,12 +19178,26 @@ "samplingConfig": { "$ref": "GoogleCloudApigeeV1RuntimeTraceSamplingConfig", "description": "Trace configuration for all API proxies in an environment." +}, +"traceProtocol": { +"description": "Optional. The trace protocol to use.", +"enum": [ +"TRACE_PROTOCOL_UNSPECIFIED", +"OPEN_CENSUS", +"OTLP" +], +"enumDescriptions": [ +"Protocol unspecified. Defaults to OPEN_CENSUS.", +"Uses OpenCensus protocol.", +"Uses OpenTelemetry Protocol (OTLP)." +], +"type": "string" } }, "type": "object" }, "GoogleCloudApigeeV1RuntimeTraceConfigOverride": { -"description": "NEXT ID: 8 Trace configuration override for a specific API proxy in an environment.", +"description": "NEXT ID: 9 Trace configuration override for a specific API proxy in an environment.", "id": "GoogleCloudApigeeV1RuntimeTraceConfigOverride", "properties": { "apiProxy": { @@ -19262,7 +19209,8 @@ "type": "string" }, "openTelemetryProtocolEnabled": { -"description": "If `true`, the runtime uses OpenTelemetry Protocol (OTLP) to send trace data. Configuration Requirements (if `open_telemetry_protocol_enabled` is `true`): - Allowed `Exporter`s: `CLOUD_TRACE` or `OPEN_TELEMETRY_COLLECTOR`. - If `Exporter` is `OPEN_TELEMETRY_COLLECTOR`: - `endpoint` refers to a valid OTLP collector URL. - If `Exporter` is `CLOUD_TRACE`: - `endpoint` refers to a valid project ID", +"deprecated": true, +"description": "Optional. If `true`, the runtime uses OpenTelemetry Protocol (OTLP) to send trace data. Configuration Requirements (if `open_telemetry_protocol_enabled` is `true`): - Allowed `Exporter`s: `CLOUD_TRACE` or `OPEN_TELEMETRY_COLLECTOR`. - If `Exporter` is `OPEN_TELEMETRY_COLLECTOR`: - `endpoint` refers to a valid OTLP collector URL. - If `Exporter` is `CLOUD_TRACE`: - `endpoint` refers to a valid project ID Deprecated: Use trace_protocol instead.", "type": "boolean" }, "revisionCreateTime": { @@ -19278,6 +19226,20 @@ "$ref": "GoogleCloudApigeeV1RuntimeTraceSamplingConfig", "description": "Trace configuration override for a specific API proxy in an environment." }, +"traceProtocol": { +"description": "Optional. The trace protocol to use.", +"enum": [ +"TRACE_PROTOCOL_UNSPECIFIED", +"OPEN_CENSUS", +"OTLP" +], +"enumDescriptions": [ +"Protocol unspecified. Defaults to OPEN_CENSUS.", +"Uses OpenCensus protocol.", +"Uses OpenTelemetry Protocol (OTLP)." +], +"type": "string" +}, "uid": { "description": "Unique ID for the configuration override. The ID will only change if the override is deleted and recreated. Corresponds to name's \"override\" field.", "type": "string" @@ -21256,18 +21218,20 @@ "type": "string" }, "exporter": { -"description": "Required. Exporter that is used to view the distributed trace captured using OpenCensus. An exporter sends traces to any backend that is capable of consuming them. Recorded spans can be exported by registered exporters.", +"description": "Required. Exporter that is used to view the distributed trace captured using the chosen trace protocol. An exporter sends traces to any backend that is capable of consuming them. Recorded spans can be exported by registered exporters.", "enum": [ "EXPORTER_UNSPECIFIED", "JAEGER", "CLOUD_TRACE", -"OPEN_TELEMETRY_COLLECTOR" +"OPEN_TELEMETRY_COLLECTOR", +"OPEN_TELEMETRY_CLOUD_TRACE" ], "enumDescriptions": [ "Exporter unspecified", -"Jaeger exporter", -"Cloudtrace exporter", -"Open Telemetry Collector" +"Exports events to Jaeger. Compatible with OpenCensus protocol.", +"Exports events to Cloud Trace. Compatible with OpenCensus protocol.", +"OpenTelemetry Collector. Compatible with OpenTelemetry protocol.", +"Exports events to Cloud Trace. Compatible with OpenTelemetry protocol." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/apim.v1alpha.json b/googleapiclient/discovery_cache/documents/apim.v1alpha.json index 067979574c..6cdc7f4f1e 100644 --- a/googleapiclient/discovery_cache/documents/apim.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/apim.v1alpha.json @@ -160,7 +160,7 @@ ] }, "list": { -"description": "Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.", +"description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "flatPath": "v1alpha/projects/{projectsId}/locations", "httpMethod": "GET", "id": "apim.projects.locations.list", @@ -851,7 +851,7 @@ } } }, -"revision": "20260128", +"revision": "20260325", "rootUrl": "https://apim.googleapis.com/", "schemas": { "ApiObservation": { diff --git a/googleapiclient/discovery_cache/documents/apphub.v1.json b/googleapiclient/discovery_cache/documents/apphub.v1.json index f23380efbf..3b4225ed89 100644 --- a/googleapiclient/discovery_cache/documents/apphub.v1.json +++ b/googleapiclient/discovery_cache/documents/apphub.v1.json @@ -188,7 +188,7 @@ ] }, "list": { -"description": "Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.", +"description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "flatPath": "v1/projects/{projectsId}/locations", "httpMethod": "GET", "id": "apphub.projects.locations.list", @@ -1486,7 +1486,7 @@ } } }, -"revision": "20260316", +"revision": "20260323", "rootUrl": "https://apphub.googleapis.com/", "schemas": { "Application": { diff --git a/googleapiclient/discovery_cache/documents/apphub.v1alpha.json b/googleapiclient/discovery_cache/documents/apphub.v1alpha.json index cc45eb6c97..222968135e 100644 --- a/googleapiclient/discovery_cache/documents/apphub.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/apphub.v1alpha.json @@ -188,7 +188,7 @@ ] }, "list": { -"description": "Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.", +"description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "flatPath": "v1alpha/projects/{projectsId}/locations", "httpMethod": "GET", "id": "apphub.projects.locations.list", @@ -1578,7 +1578,7 @@ } } }, -"revision": "20260316", +"revision": "20260323", "rootUrl": "https://apphub.googleapis.com/", "schemas": { "Application": { diff --git a/googleapiclient/discovery_cache/documents/backupdr.v1.json b/googleapiclient/discovery_cache/documents/backupdr.v1.json index e8ffe3f6a9..f4d2046616 100644 --- a/googleapiclient/discovery_cache/documents/backupdr.v1.json +++ b/googleapiclient/discovery_cache/documents/backupdr.v1.json @@ -160,7 +160,7 @@ ] }, "list": { -"description": "Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.", +"description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "flatPath": "v1/projects/{projectsId}/locations", "httpMethod": "GET", "id": "backupdr.projects.locations.list", @@ -2262,7 +2262,7 @@ } } }, -"revision": "20260318", +"revision": "20260325", "rootUrl": "https://backupdr.googleapis.com/", "schemas": { "AbandonBackupRequest": { @@ -3274,6 +3274,10 @@ "readOnly": true, "type": "string" }, +"computeInstanceBackupPlanProperties": { +"$ref": "ComputeInstanceBackupPlanProperties", +"description": "Optional. Defines optional properties specific to backups of disk-based resources, such as Compute Engine. This includes settings like whether to perform a guest flush." +}, "createTime": { "description": "Output only. When the `BackupPlan` was created.", "format": "google-datetime", @@ -3841,6 +3845,17 @@ }, "type": "object" }, +"ComputeInstanceBackupPlanProperties": { +"description": "--- ComputeInstanceBackupPlanProperties Message ---", +"id": "ComputeInstanceBackupPlanProperties", +"properties": { +"guestFlush": { +"description": "Optional. Indicates whether to perform a guest flush operation before taking a compute backup. When set to false, the system will create crash-consistent backups. Default value is false.", +"type": "boolean" +} +}, +"type": "object" +}, "ComputeInstanceBackupProperties": { "description": "ComputeInstanceBackupProperties represents Compute Engine instance backup properties.", "id": "ComputeInstanceBackupProperties", @@ -3867,6 +3882,10 @@ }, "type": "array" }, +"guestFlush": { +"description": "Optional. Indicates whether to perform a guest flush operation before taking a compute backup. When set to false, the system will create crash-consistent backups. Default value is false.", +"type": "boolean" +}, "keyRevocationActionType": { "description": "KeyRevocationActionType of the instance. Supported options are \"STOP\" and \"NONE\". The default value is \"NONE\" if it is not specified.", "enum": [ @@ -5629,8 +5648,10 @@ "CLOUD_SQL", "ALLOY_DB", "FILESTORE", +"BV_AF", "CEP_MONITORING_COMPUTE_INSTANCE", -"CEP_MONITORING_DISK" +"CEP_MONITORING_DISK", +"BV_CUSTOM_PROBERS" ], "enumDescriptions": [ "", @@ -5642,7 +5663,9 @@ "", "", "", -"" +"", +"", +"Remove once parity achieved between BV_AF and BV_CUSTOM_PROBERS." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/bigtableadmin.v2.json b/googleapiclient/discovery_cache/documents/bigtableadmin.v2.json index f6e283f1dd..89f455aedd 100644 --- a/googleapiclient/discovery_cache/documents/bigtableadmin.v2.json +++ b/googleapiclient/discovery_cache/documents/bigtableadmin.v2.json @@ -833,6 +833,37 @@ "https://www.googleapis.com/auth/cloud-platform.read-only" ] }, +"getMemoryLayer": { +"description": "Gets information about the memory layer of a cluster.", +"flatPath": "v2/projects/{projectsId}/instances/{instancesId}/clusters/{clustersId}/memoryLayer", +"httpMethod": "GET", +"id": "bigtableadmin.projects.instances.clusters.getMemoryLayer", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The unique name of the requested cluster's memory layer. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}/memoryLayer`.", +"location": "path", +"pattern": "^projects/[^/]+/instances/[^/]+/clusters/[^/]+/memoryLayer$", +"required": true, +"type": "string" +} +}, +"path": "v2/{+name}", +"response": { +"$ref": "MemoryLayer" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigtable.admin", +"https://www.googleapis.com/auth/bigtable.admin.cluster", +"https://www.googleapis.com/auth/bigtable.admin.instance", +"https://www.googleapis.com/auth/cloud-bigtable.admin", +"https://www.googleapis.com/auth/cloud-bigtable.admin.cluster", +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only" +] +}, "list": { "description": "Lists information about clusters in an instance.", "flatPath": "v2/projects/{projectsId}/instances/{instancesId}/clusters", @@ -941,6 +972,45 @@ "https://www.googleapis.com/auth/cloud-bigtable.admin.cluster", "https://www.googleapis.com/auth/cloud-platform" ] +}, +"updateMemoryLayer": { +"description": "Updates the memory layer of a cluster. To enable the memory layer, set the memory_config. To disable the memory layer, unset the memory_config.", +"flatPath": "v2/projects/{projectsId}/instances/{instancesId}/clusters/{clustersId}/memoryLayer", +"httpMethod": "PATCH", +"id": "bigtableadmin.projects.instances.clusters.updateMemoryLayer", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Identifier. Name of the memory layer. This is always: \"projects/{project}/instances/{instance}/clusters/{cluster}/memoryLayer\".", +"location": "path", +"pattern": "^projects/[^/]+/instances/[^/]+/clusters/[^/]+/memoryLayer$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Optional. The list of fields to update.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v2/{+name}", +"request": { +"$ref": "MemoryLayer" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigtable.admin", +"https://www.googleapis.com/auth/bigtable.admin.cluster", +"https://www.googleapis.com/auth/bigtable.admin.instance", +"https://www.googleapis.com/auth/cloud-bigtable.admin", +"https://www.googleapis.com/auth/cloud-bigtable.admin.cluster", +"https://www.googleapis.com/auth/cloud-platform" +] } }, "resources": { @@ -1315,6 +1385,51 @@ ] } } +}, +"memoryLayers": { +"methods": { +"list": { +"description": "Lists information about memory layers.", +"flatPath": "v2/projects/{projectsId}/instances/{instancesId}/clusters/{clustersId}/memoryLayers", +"httpMethod": "GET", +"id": "bigtableadmin.projects.instances.clusters.memoryLayers.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "Optional. The maximum number of memory layers to return. The service may return fewer than this value.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A page token, received from a previous `ListMemoryLayers` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListMemoryLayers` must match the call that provided the page token.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The unique name of the cluster for which a list of memory layers is requested. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}`. Use `{cluster} = '-'` to list MemoryLayers for all Clusters in an instance, e.g., `projects/myproject/instances/myinstance/clusters/-`.", +"location": "path", +"pattern": "^projects/[^/]+/instances/[^/]+/clusters/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v2/{+parent}/memoryLayers", +"response": { +"$ref": "ListMemoryLayersResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigtable.admin", +"https://www.googleapis.com/auth/bigtable.admin.cluster", +"https://www.googleapis.com/auth/bigtable.admin.instance", +"https://www.googleapis.com/auth/cloud-bigtable.admin", +"https://www.googleapis.com/auth/cloud-bigtable.admin.cluster", +"https://www.googleapis.com/auth/cloud-platform" +] +} +} } } }, @@ -3061,7 +3176,7 @@ "locations": { "methods": { "list": { -"description": "Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.", +"description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "flatPath": "v2/projects/{projectsId}/locations", "httpMethod": "GET", "id": "bigtableadmin.projects.locations.list", @@ -3118,7 +3233,7 @@ } } }, -"revision": "20260320", +"revision": "20260331", "rootUrl": "https://bigtableadmin.googleapis.com/", "schemas": { "AppProfile": { @@ -3253,6 +3368,13 @@ "format": "google-duration", "type": "string" }, +"locations": { +"description": "Optional. A list of Cloud Bigtable zones where automated backups are allowed to be created. If empty, automated backups will be created in all zones of the instance. Locations are in the format `projects/{project}/locations/{zone}`. This field can only set for tables in Enterprise Plus instances.", +"items": { +"type": "string" +}, +"type": "array" +}, "retentionPeriod": { "description": "Required. How long the automated backups should be retained. Values must be at least 3 days and at most 90 days.", "format": "google-duration", @@ -4256,6 +4378,19 @@ }, "type": "object" }, +"GoogleBigtableAdminV2MemoryLayerMemoryConfig": { +"description": "Configuration of a memory layer.", +"id": "GoogleBigtableAdminV2MemoryLayerMemoryConfig", +"properties": { +"storageSizeGib": { +"description": "Output only. Reporting the current size of the memory layer in GiB.", +"format": "int32", +"readOnly": true, +"type": "integer" +} +}, +"type": "object" +}, "GoogleBigtableAdminV2TypeAggregate": { "description": "A value that combines incremental updates into a summarized value. Data is never directly written or read using type `Aggregate`. Writes provide either the `input_type` or `state_type`, and reads always return the `state_type` .", "id": "GoogleBigtableAdminV2TypeAggregate", @@ -4412,6 +4547,44 @@ "properties": {}, "type": "object" }, +"GoogleBigtableAdminV2TypeInt32": { +"description": "Int32 Values of type `Int32` are stored in `Value.int_value`.", +"id": "GoogleBigtableAdminV2TypeInt32", +"properties": { +"encoding": { +"$ref": "GoogleBigtableAdminV2TypeInt32Encoding", +"description": "The encoding to use when converting to or from lower level types." +} +}, +"type": "object" +}, +"GoogleBigtableAdminV2TypeInt32Encoding": { +"description": "Rules used to convert to or from lower level types.", +"id": "GoogleBigtableAdminV2TypeInt32Encoding", +"properties": { +"bigEndianBytes": { +"$ref": "GoogleBigtableAdminV2TypeInt32EncodingBigEndianBytes", +"description": "Use `BigEndianBytes` encoding." +}, +"orderedCodeBytes": { +"$ref": "GoogleBigtableAdminV2TypeInt32EncodingOrderedCodeBytes", +"description": "Use `OrderedCodeBytes` encoding." +} +}, +"type": "object" +}, +"GoogleBigtableAdminV2TypeInt32EncodingBigEndianBytes": { +"description": "Encodes the value as a 4-byte big-endian two's complement value. Sorted mode: non-negative values are supported. Distinct mode: all values are supported. Compatible with: - BigQuery `BINARY` encoding - HBase `Bytes.toBytes` - Java `ByteBuffer.putInt()` with `ByteOrder.BIG_ENDIAN`", +"id": "GoogleBigtableAdminV2TypeInt32EncodingBigEndianBytes", +"properties": {}, +"type": "object" +}, +"GoogleBigtableAdminV2TypeInt32EncodingOrderedCodeBytes": { +"description": "Encodes the value in a variable length binary format of up to 5 bytes. Values that are closer to zero use fewer bytes. Sorted mode: all values are supported. Distinct mode: all values are supported.", +"id": "GoogleBigtableAdminV2TypeInt32EncodingOrderedCodeBytes", +"properties": {}, +"type": "object" +}, "GoogleBigtableAdminV2TypeInt64": { "description": "Int64 Values of type `Int64` are stored in `Value.int_value`.", "id": "GoogleBigtableAdminV2TypeInt64", @@ -4957,6 +5130,31 @@ }, "type": "object" }, +"ListMemoryLayersResponse": { +"description": "Response message for BigtableInstanceAdmin.ListMemoryLayers.", +"id": "ListMemoryLayersResponse", +"properties": { +"failedLocations": { +"description": "Locations from which MemoryLayer information could not be retrieved, due to an outage or some other transient condition. MemoryLayers from these locations may be missing from `memory_layers`, or may only have partial information returned. Values are of the form `projects//locations/`", +"items": { +"type": "string" +}, +"type": "array" +}, +"memoryLayers": { +"description": "The list of requested memory layers.", +"items": { +"$ref": "MemoryLayer" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", +"type": "string" +} +}, +"type": "object" +}, "ListOperationsResponse": { "description": "The response message for Operations.ListOperations.", "id": "ListOperationsResponse", @@ -5106,6 +5304,50 @@ }, "type": "object" }, +"MemoryConfig": { +"description": "If set, eligible single-row requests (currently limited to ReadRows) using this app profile will be routed to the memory layer. All eligible writes populate the memory layer. MemoryConfig can only be set if the AppProfile uses single cluster routing and the configured cluster has a memory layer enabled.", +"id": "MemoryConfig", +"properties": {}, +"type": "object" +}, +"MemoryLayer": { +"description": "The memory layer of a cluster. A memory layer serves reads from memory without hitting the backing persistent data store.", +"id": "MemoryLayer", +"properties": { +"etag": { +"description": "Optional. The etag for this memory layer. This may be sent on update requests to ensure that the client has an up-to-date value before proceeding. The server returns an ABORTED error on a mismatched etag.", +"type": "string" +}, +"memoryConfig": { +"$ref": "GoogleBigtableAdminV2MemoryLayerMemoryConfig", +"description": "The configuration of this memory layer. Set an empty `memory_config` to enable the memory layer. Unset this to disable the memory layer." +}, +"name": { +"description": "Identifier. Name of the memory layer. This is always: \"projects/{project}/instances/{instance}/clusters/{cluster}/memoryLayer\".", +"type": "string" +}, +"state": { +"description": "Output only. The current state of the memory layer.", +"enum": [ +"STATE_NOT_KNOWN", +"READY", +"ENABLING", +"RESIZING", +"DISABLED" +], +"enumDescriptions": [ +"The state of the memory layer could not be determined.", +"The memory layer has been successfully enabled and is ready to serve requests.", +"The memory layer is currently being enabled, and may be disabled if the enablement process encounters an error. A cluster may not be able to serve requests from the memory layer while being enabled.", +"The memory layer is currently being resized, and may revert to its previous storage size if the process encounters an error. The memory layer is still capable of serving requests while being resized, but may exhibit performance as if its number of allocated nodes is between the starting and requested states.", +"The memory layer is disabled. The default state for a cluster without a memory layer." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "Modification": { "description": "A create, update, or delete of a particular column family.", "id": "Modification", @@ -5482,6 +5724,10 @@ "description": "Standard options for isolating this app profile's traffic from other use cases.", "id": "StandardIsolation", "properties": { +"memoryConfig": { +"$ref": "MemoryConfig", +"description": "Optional. The memory config to use for requests sent using this app profile." +}, "priority": { "description": "The priority of requests sent using this app profile.", "enum": [ @@ -5754,6 +6000,10 @@ "$ref": "GoogleBigtableAdminV2TypeGeography", "description": "Geography" }, +"int32Type": { +"$ref": "GoogleBigtableAdminV2TypeInt32", +"description": "Int32" +}, "int64Type": { "$ref": "GoogleBigtableAdminV2TypeInt64", "description": "Int64" @@ -5972,6 +6222,43 @@ }, "type": "object" }, +"UpdateMemoryLayerMetadata": { +"description": "The metadata for the Operation returned by UpdateMemoryLayer.", +"id": "UpdateMemoryLayerMetadata", +"properties": { +"finishTime": { +"description": "The time at which the operation failed or was completed successfully.", +"format": "google-datetime", +"type": "string" +}, +"originalRequest": { +"$ref": "UpdateMemoryLayerRequest", +"description": "The request that prompted the initiation of this UpdateMemoryLayer operation." +}, +"requestTime": { +"description": "The time at which the original request was received.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"UpdateMemoryLayerRequest": { +"description": "Request message for BigtableInstanceAdmin.UpdateMemoryLayer.", +"id": "UpdateMemoryLayerRequest", +"properties": { +"memoryLayer": { +"$ref": "MemoryLayer", +"description": "Required. The memory layer to update. The memory layer's `name` format is as follows: `projects/{project}/instances/{instance}/clusters/{cluster}/memoryLayer`." +}, +"updateMask": { +"description": "Optional. The list of fields to update.", +"format": "google-fieldmask", +"type": "string" +} +}, +"type": "object" +}, "UpdateSchemaBundleMetadata": { "description": "The metadata for the Operation returned by UpdateSchemaBundle.", "id": "UpdateSchemaBundleMetadata", diff --git a/googleapiclient/discovery_cache/documents/certificatemanager.v1.json b/googleapiclient/discovery_cache/documents/certificatemanager.v1.json index f6dfd199bf..43fb238375 100644 --- a/googleapiclient/discovery_cache/documents/certificatemanager.v1.json +++ b/googleapiclient/discovery_cache/documents/certificatemanager.v1.json @@ -135,7 +135,7 @@ ] }, "list": { -"description": "Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.", +"description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "flatPath": "v1/projects/{projectsId}/locations", "httpMethod": "GET", "id": "certificatemanager.projects.locations.list", @@ -1325,7 +1325,7 @@ } } }, -"revision": "20260316", +"revision": "20260323", "rootUrl": "https://certificatemanager.googleapis.com/", "schemas": { "AllowlistedCertificate": { diff --git a/googleapiclient/discovery_cache/documents/ces.v1.json b/googleapiclient/discovery_cache/documents/ces.v1.json index e428f85706..ff77f9c5c8 100644 --- a/googleapiclient/discovery_cache/documents/ces.v1.json +++ b/googleapiclient/discovery_cache/documents/ces.v1.json @@ -151,7 +151,7 @@ ] }, "list": { -"description": "Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.", +"description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "flatPath": "v1/projects/{projectsId}/locations", "httpMethod": "GET", "id": "ces.projects.locations.list", @@ -2275,7 +2275,7 @@ } } }, -"revision": "20260318", +"revision": "20260325", "rootUrl": "https://ces.googleapis.com/", "schemas": { "Action": { @@ -5081,7 +5081,8 @@ "type": "boolean" }, "fallbackAction": { -"description": "Optional. The action to perform when an agent receives input in an unsupported language. This can be a predefined action or a custom tool call. Valid values are: - A tool's full resource name, which triggers a specific tool execution. - A predefined system action, such as \"escalate\" or \"exit\", which triggers an EndSession signal with corresponding metadata to terminate the conversation.", +"deprecated": true, +"description": "Optional. Deprecated: This feature is no longer supported. Use `enable_multilingual_support` instead to improve handling of multilingual input. The action to perform when an agent receives input in an unsupported language. This can be a predefined action or a custom tool call. Valid values are: - A tool's full resource name, which triggers a specific tool execution. - A predefined system action, such as \"escalate\" or \"exit\", which triggers an EndSession signal with corresponding metadata to terminate the conversation.", "type": "string" }, "supportedLanguageCodes": { diff --git a/googleapiclient/discovery_cache/documents/ces.v1beta.json b/googleapiclient/discovery_cache/documents/ces.v1beta.json index d53cf74d4e..7809468a46 100644 --- a/googleapiclient/discovery_cache/documents/ces.v1beta.json +++ b/googleapiclient/discovery_cache/documents/ces.v1beta.json @@ -177,7 +177,7 @@ ] }, "list": { -"description": "Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.", +"description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "flatPath": "v1beta/projects/{projectsId}/locations", "httpMethod": "GET", "id": "ces.projects.locations.list", @@ -386,6 +386,35 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"generateAppResource": { +"description": "Generates specific resources (e.g. agent) in the app using LLM assistant.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}:generateAppResource", +"httpMethod": "POST", +"id": "ces.projects.locations.apps.generateAppResource", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The resource name of the app to generate the resource for.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+parent}:generateAppResource", +"request": { +"$ref": "GenerateAppResourceRequest" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/ces", +"https://www.googleapis.com/auth/cloud-platform" +] +}, "get": { "description": "Gets details of the specified app.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}", @@ -3418,7 +3447,7 @@ } } }, -"revision": "20260318", +"revision": "20260325", "rootUrl": "https://ces.googleapis.com/", "schemas": { "Action": { @@ -7594,6 +7623,37 @@ }, "type": "object" }, +"FileContext": { +"description": "Files to be used as context. Files can be provided as raw bytes.", +"id": "FileContext", +"properties": { +"fileBytes": { +"$ref": "FileContextFileBytes", +"description": "Optional. File provided as raw bytes." +} +}, +"type": "object" +}, +"FileContextFileBytes": { +"description": "File provided as raw bytes.", +"id": "FileContextFileBytes", +"properties": { +"data": { +"description": "Required. Raw bytes of the file.", +"format": "byte", +"type": "string" +}, +"fileName": { +"description": "Required. The name of the file provided as raw bytes.", +"type": "string" +}, +"mimeType": { +"description": "Required. The IANA standard MIME type of the source data.", +"type": "string" +} +}, +"type": "object" +}, "FileSearchTool": { "description": "The file search tool allows the agent to search across the files uploaded by the app/agent developer. It has presets to give relatively good quality search over the uploaded files and summarization of the retrieved results.", "id": "FileSearchTool", @@ -7627,6 +7687,214 @@ }, "type": "object" }, +"GenerateAppResourceRequest": { +"description": "Request message for AgentService.GenerateAppResource.", +"id": "GenerateAppResourceRequest", +"properties": { +"agent": { +"$ref": "Agent", +"description": "The agent resource to be used by the LLM assistant, can be empty for generating a new agent." +}, +"appGenerationConfig": { +"$ref": "GenerateAppResourceRequestAppGenerationConfig", +"description": "Optional. The configuration to be used to generate the agents and tools." +}, +"evaluationGenerationConfig": { +"$ref": "GenerateAppResourceRequestEvaluationGenerationConfig", +"description": "Optional. The configuration to be used to generate the evaluations." +}, +"evaluationPersonasGenerationConfig": { +"$ref": "GenerateAppResourceRequestEvaluationPersonasGenerationConfig", +"description": "Optional. The configuration to be used to generate the evaluation personas." +}, +"hillClimbingFixConfig": { +"$ref": "GenerateAppResourceRequestHillClimbingFixConfig", +"description": "Optional. The configuration to be used for hill climbing fixes." +}, +"qualityReportGenerationConfig": { +"$ref": "GenerateAppResourceRequestQualityReportGenerationConfig", +"description": "Optional. The configuration to be used for quality report generation." +}, +"refineInstructions": { +"description": "Optional. List of refine instructions to be used to refine the resource.", +"items": { +"$ref": "GenerateAppResourceRequestRefineInstructions" +}, +"type": "array" +}, +"tool": { +"$ref": "Tool", +"description": "The tool resource to be used by the LLM assistant, can be empty for generating a new tool." +}, +"toolGenerationConfig": { +"$ref": "GenerateAppResourceRequestToolGenerationConfig", +"description": "Optional. The configuration to be used to generate the tool." +}, +"toolset": { +"$ref": "Toolset", +"description": "The toolset resource to be used by the LLM assistant, can be empty for generating a new toolset." +} +}, +"type": "object" +}, +"GenerateAppResourceRequestAppGenerationConfig": { +"description": "The configuration to be used to generate the app.", +"id": "GenerateAppResourceRequestAppGenerationConfig", +"properties": { +"context": { +"description": "Optional. The context which describes the requirements of the agents & tools to be generated.", +"type": "string" +}, +"datasetId": { +"description": "Optional. The insights dataset to be used to fetch conversation data for generating the agents & tools. Format: `projects/{project}/locations/{location}/datasets/{dataset}`.", +"type": "string" +}, +"fileContexts": { +"description": "Optional. The files to be used as context.", +"items": { +"$ref": "FileContext" +}, +"type": "array" +}, +"gcsLocation": { +"description": "Optional. The Cloud Storage location to store the generated question answer data to be used by the Datastore tool. This data is generated only when using conversation data as an input source. The location must be in the same project as the app. Format: `gs://...`.", +"type": "string" +}, +"generateEvaluations": { +"description": "Optional. Whether to generate the evaluations for the app. If true, the provided context will be used to generate the evaluations data.", +"type": "boolean" +} +}, +"type": "object" +}, +"GenerateAppResourceRequestEvaluationGenerationConfig": { +"description": "The configuration to be used to generate the evaluations.", +"id": "GenerateAppResourceRequestEvaluationGenerationConfig", +"properties": { +"datasetId": { +"description": "Optional. The insights dataset to be used to fetch conversation data for generating the evaluations. Format: `projects/{project}/locations/{location}/datasets/{dataset}`.", +"type": "string" +} +}, +"type": "object" +}, +"GenerateAppResourceRequestEvaluationPersonasGenerationConfig": { +"description": "The configuration to be used to generate the evaluation personas.", +"id": "GenerateAppResourceRequestEvaluationPersonasGenerationConfig", +"properties": {}, +"type": "object" +}, +"GenerateAppResourceRequestHillClimbingFixConfig": { +"description": "The configuration to be used for hill climbing fixes.", +"id": "GenerateAppResourceRequestHillClimbingFixConfig", +"properties": { +"qualityReport": { +"$ref": "QualityReport", +"description": "Required. The quality report used to inform the instruction following fix." +} +}, +"type": "object" +}, +"GenerateAppResourceRequestQualityReportGenerationConfig": { +"description": "The configuration to be used for quality report generation.", +"id": "GenerateAppResourceRequestQualityReportGenerationConfig", +"properties": { +"evaluationRun": { +"description": "Required. The evaluation run used to inform quality report analysis.", +"type": "string" +} +}, +"type": "object" +}, +"GenerateAppResourceRequestRefineInstructions": { +"description": "The instructions to be used to refine a part of the resource. The part of the resource can be specified with a start index, end index and a field mask. For example, if you want to refine a part of the agent instructions you can specify the index of the first character of the instructions, the index of the last character of the instructions and the field mask as \"instructions\".", +"id": "GenerateAppResourceRequestRefineInstructions", +"properties": { +"endIndex": { +"description": "Required. The last character (inclusive) of the text to refine.", +"format": "int64", +"type": "string" +}, +"fieldMask": { +"description": "Required. The field of the resource being refined. Only one field is allowed per RefineInstructions. If refining agent instructions, the field mask should be \"instructions\".", +"format": "google-fieldmask", +"type": "string" +}, +"instructions": { +"description": "Required. The instructions to refine the resource.", +"type": "string" +}, +"startIndex": { +"description": "Required. The first character (inclusive) of the text to refine.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"GenerateAppResourceRequestToolGenerationConfig": { +"description": "The configuration to be used to generate a tool.", +"id": "GenerateAppResourceRequestToolGenerationConfig", +"properties": { +"context": { +"description": "Optional. The context which describes the tool to be generated. This can be empty if the tool request & response are provided.", +"type": "string" +}, +"fileContexts": { +"description": "Optional. The files to be used as context.", +"items": { +"$ref": "FileContext" +}, +"type": "array" +}, +"openApiToolsetGenerationConfig": { +"$ref": "GenerateAppResourceRequestToolGenerationConfigOpenApiToolsetGenerationConfig", +"description": "Optional. The configuration to be used to generate an Open API schema." +} +}, +"type": "object" +}, +"GenerateAppResourceRequestToolGenerationConfigOpenApiToolsetGenerationConfig": { +"description": "The configuration to be used to generate an Open API schema.", +"id": "GenerateAppResourceRequestToolGenerationConfigOpenApiToolsetGenerationConfig", +"properties": { +"operationGenerationConfigs": { +"description": "Required. The list of operations to be added to the Open API schema.", +"items": { +"$ref": "GenerateAppResourceRequestToolGenerationConfigOpenApiToolsetGenerationConfigOperationGenerationConfig" +}, +"type": "array" +}, +"uri": { +"description": "Required. The base uri of the tool.", +"type": "string" +} +}, +"type": "object" +}, +"GenerateAppResourceRequestToolGenerationConfigOpenApiToolsetGenerationConfigOperationGenerationConfig": { +"description": "The configuration to be used to generate an operation in the Open API schema.", +"id": "GenerateAppResourceRequestToolGenerationConfigOpenApiToolsetGenerationConfigOperationGenerationConfig", +"properties": { +"method": { +"description": "Required. The uri of the tool. This should include query and path parameters if any.", +"type": "string" +}, +"path": { +"description": "Required. The path of the tool to be appended to the base uri. This should include query and path parameters if any.", +"type": "string" +}, +"requestJson": { +"description": "Required. A sample request to the tool in JSON format. Skip if the tool does not support request body.", +"type": "string" +}, +"responseJson": { +"description": "Required. A sample response from the tool in JSON format.", +"type": "string" +} +}, +"type": "object" +}, "GenerateAppResourceResponse": { "description": "Response message for AgentService.GenerateAppResource.", "id": "GenerateAppResourceResponse", @@ -8375,7 +8643,8 @@ "type": "boolean" }, "fallbackAction": { -"description": "Optional. The action to perform when an agent receives input in an unsupported language. This can be a predefined action or a custom tool call. Valid values are: - A tool's full resource name, which triggers a specific tool execution. - A predefined system action, such as \"escalate\" or \"exit\", which triggers an EndSession signal with corresponding metadata to terminate the conversation.", +"deprecated": true, +"description": "Optional. Deprecated: This feature is no longer supported. Use `enable_multilingual_support` instead to improve handling of multilingual input. The action to perform when an agent receives input in an unsupported language. This can be a predefined action or a custom tool call. Valid values are: - A tool's full resource name, which triggers a specific tool execution. - A predefined system action, such as \"escalate\" or \"exit\", which triggers an EndSession signal with corresponding metadata to terminate the conversation.", "type": "string" }, "supportedLanguageCodes": { diff --git a/googleapiclient/discovery_cache/documents/chat.v1.json b/googleapiclient/discovery_cache/documents/chat.v1.json index 3dbcb27bbf..d170a768f1 100644 --- a/googleapiclient/discovery_cache/documents/chat.v1.json +++ b/googleapiclient/discovery_cache/documents/chat.v1.json @@ -23,6 +23,9 @@ "https://www.googleapis.com/auth/chat.app.memberships": { "description": "On their own behalf, apps in Google Chat can see, add, update, and remove members from conversations and spaces" }, +"https://www.googleapis.com/auth/chat.app.memberships.readonly": { +"description": "On their own behalf, apps in Google Chat can see members of conversations and spaces" +}, "https://www.googleapis.com/auth/chat.app.messages.readonly": { "description": "On their own behalf, apps in Google Chat can see all messages and their associated reactions and message content" }, @@ -32,6 +35,9 @@ "https://www.googleapis.com/auth/chat.app.spaces.create": { "description": "On their own behalf, apps in Google Chat can create conversations and spaces" }, +"https://www.googleapis.com/auth/chat.app.spaces.readonly": { +"description": "On their own behalf, apps in Google Chat can see conversations and spaces and their metadata (including history settings and access settings)" +}, "https://www.googleapis.com/auth/chat.bot": { "description": "Private Service: https://www.googleapis.com/auth/chat.bot" }, @@ -648,7 +654,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/chat.admin.spaces", -"https://www.googleapis.com/auth/chat.admin.spaces.readonly" +"https://www.googleapis.com/auth/chat.admin.spaces.readonly", +"https://www.googleapis.com/auth/chat.spaces", +"https://www.googleapis.com/auth/chat.spaces.readonly" ] }, "setup": { @@ -1310,8 +1318,10 @@ }, "scopes": [ "https://www.googleapis.com/auth/chat.app.memberships", +"https://www.googleapis.com/auth/chat.app.memberships.readonly", "https://www.googleapis.com/auth/chat.app.messages.readonly", "https://www.googleapis.com/auth/chat.app.spaces", +"https://www.googleapis.com/auth/chat.app.spaces.readonly", "https://www.googleapis.com/auth/chat.memberships", "https://www.googleapis.com/auth/chat.memberships.readonly", "https://www.googleapis.com/auth/chat.messages", @@ -1361,8 +1371,10 @@ }, "scopes": [ "https://www.googleapis.com/auth/chat.app.memberships", +"https://www.googleapis.com/auth/chat.app.memberships.readonly", "https://www.googleapis.com/auth/chat.app.messages.readonly", "https://www.googleapis.com/auth/chat.app.spaces", +"https://www.googleapis.com/auth/chat.app.spaces.readonly", "https://www.googleapis.com/auth/chat.memberships", "https://www.googleapis.com/auth/chat.memberships.readonly", "https://www.googleapis.com/auth/chat.messages", @@ -1773,7 +1785,7 @@ } } }, -"revision": "20260320", +"revision": "20260327", "rootUrl": "https://chat.googleapis.com/", "schemas": { "AccessSettings": { @@ -2879,7 +2891,7 @@ "type": "object" }, "GoogleAppsCardV1Card": { -"description": "A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. Any widgets beyond this limit are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { \"cardsV2\": [ { \"cardId\": \"unique-card-id\", \"card\": { \"header\": { \"title\": \"Sasha\", \"subtitle\": \"Software Engineer\", \"imageUrl\": \"https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png\", \"imageType\": \"CIRCLE\", \"imageAltText\": \"Avatar for Sasha\" }, \"sections\": [ { \"header\": \"Contact Info\", \"collapsible\": true, \"uncollapsibleWidgetsCount\": 1, \"widgets\": [ { \"decoratedText\": { \"startIcon\": { \"knownIcon\": \"EMAIL\" }, \"text\": \"sasha@example.com\" } }, { \"decoratedText\": { \"startIcon\": { \"knownIcon\": \"PERSON\" }, \"text\": \"Online\" } }, { \"decoratedText\": { \"startIcon\": { \"knownIcon\": \"PHONE\" }, \"text\": \"+1 (555) 555-1234\" } }, { \"buttonList\": { \"buttons\": [ { \"text\": \"Share\", \"onClick\": { \"openLink\": { \"url\": \"https://example.com/share\" } } }, { \"text\": \"Edit\", \"onClick\": { \"action\": { \"function\": \"goToView\", \"parameters\": [ { \"key\": \"viewType\", \"value\": \"EDIT\" } ] } } } ] } } ] } ] } } ] } ```", +"description": "A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. If a section's widgets push the total count above 100, that entire section and all following sections are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { \"cardsV2\": [ { \"cardId\": \"unique-card-id\", \"card\": { \"header\": { \"title\": \"Sasha\", \"subtitle\": \"Software Engineer\", \"imageUrl\": \"https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png\", \"imageType\": \"CIRCLE\", \"imageAltText\": \"Avatar for Sasha\" }, \"sections\": [ { \"header\": \"Contact Info\", \"collapsible\": true, \"uncollapsibleWidgetsCount\": 1, \"widgets\": [ { \"decoratedText\": { \"startIcon\": { \"knownIcon\": \"EMAIL\" }, \"text\": \"sasha@example.com\" } }, { \"decoratedText\": { \"startIcon\": { \"knownIcon\": \"PERSON\" }, \"text\": \"Online\" } }, { \"decoratedText\": { \"startIcon\": { \"knownIcon\": \"PHONE\" }, \"text\": \"+1 (555) 555-1234\" } }, { \"buttonList\": { \"buttons\": [ { \"text\": \"Share\", \"onClick\": { \"openLink\": { \"url\": \"https://example.com/share\" } } }, { \"text\": \"Edit\", \"onClick\": { \"action\": { \"function\": \"goToView\", \"parameters\": [ { \"key\": \"viewType\", \"value\": \"EDIT\" } ] } } } ] } } ] } ] } } ] } ```", "id": "GoogleAppsCardV1Card", "properties": { "cardActions": { diff --git a/googleapiclient/discovery_cache/documents/clouddeploy.v1.json b/googleapiclient/discovery_cache/documents/clouddeploy.v1.json index 4854ce7ee2..9b9d5f27a9 100644 --- a/googleapiclient/discovery_cache/documents/clouddeploy.v1.json +++ b/googleapiclient/discovery_cache/documents/clouddeploy.v1.json @@ -160,7 +160,7 @@ ] }, "list": { -"description": "Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.", +"description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "flatPath": "v1/projects/{projectsId}/locations", "httpMethod": "GET", "id": "clouddeploy.projects.locations.list", @@ -2359,7 +2359,7 @@ } } }, -"revision": "20260313", +"revision": "20260325", "rootUrl": "https://clouddeploy.googleapis.com/", "schemas": { "AbandonReleaseRequest": { diff --git a/googleapiclient/discovery_cache/documents/cloudlocationfinder.v1.json b/googleapiclient/discovery_cache/documents/cloudlocationfinder.v1.json index 962bf81588..fb615f4ca9 100644 --- a/googleapiclient/discovery_cache/documents/cloudlocationfinder.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudlocationfinder.v1.json @@ -135,7 +135,7 @@ ] }, "list": { -"description": "Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.", +"description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "flatPath": "v1/projects/{projectsId}/locations", "httpMethod": "GET", "id": "cloudlocationfinder.projects.locations.list", @@ -304,7 +304,7 @@ } } }, -"revision": "20260128", +"revision": "20260325", "rootUrl": "https://cloudlocationfinder.googleapis.com/", "schemas": { "CloudLocation": { diff --git a/googleapiclient/discovery_cache/documents/cloudlocationfinder.v1alpha.json b/googleapiclient/discovery_cache/documents/cloudlocationfinder.v1alpha.json index b75268983a..8efc0d13f3 100644 --- a/googleapiclient/discovery_cache/documents/cloudlocationfinder.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/cloudlocationfinder.v1alpha.json @@ -135,7 +135,7 @@ ] }, "list": { -"description": "Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.", +"description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "flatPath": "v1alpha/projects/{projectsId}/locations", "httpMethod": "GET", "id": "cloudlocationfinder.projects.locations.list", @@ -304,7 +304,7 @@ } } }, -"revision": "20260128", +"revision": "20260325", "rootUrl": "https://cloudlocationfinder.googleapis.com/", "schemas": { "CloudLocation": { diff --git a/googleapiclient/discovery_cache/documents/cloudtasks.v2.json b/googleapiclient/discovery_cache/documents/cloudtasks.v2.json index fe54c8bdcf..3c59a433af 100644 --- a/googleapiclient/discovery_cache/documents/cloudtasks.v2.json +++ b/googleapiclient/discovery_cache/documents/cloudtasks.v2.json @@ -160,7 +160,7 @@ ] }, "list": { -"description": "Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.", +"description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "flatPath": "v2/projects/{projectsId}/locations", "httpMethod": "GET", "id": "cloudtasks.projects.locations.list", @@ -785,7 +785,7 @@ } } }, -"revision": "20260306", +"revision": "20260330", "rootUrl": "https://cloudtasks.googleapis.com/", "schemas": { "AppEngineHttpRequest": { diff --git a/googleapiclient/discovery_cache/documents/cloudtasks.v2beta2.json b/googleapiclient/discovery_cache/documents/cloudtasks.v2beta2.json index a9a02b551e..7006ebd3ff 100644 --- a/googleapiclient/discovery_cache/documents/cloudtasks.v2beta2.json +++ b/googleapiclient/discovery_cache/documents/cloudtasks.v2beta2.json @@ -192,7 +192,7 @@ ] }, "list": { -"description": "Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.", +"description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "flatPath": "v2beta2/projects/{projectsId}/locations", "httpMethod": "GET", "id": "cloudtasks.projects.locations.list", @@ -274,6 +274,35 @@ } }, "resources": { +"operations": { +"methods": { +"get": { +"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", +"flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", +"httpMethod": "GET", +"id": "cloudtasks.projects.locations.operations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v2beta2/{+name}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, "queues": { "methods": { "create": { @@ -941,7 +970,7 @@ } } }, -"revision": "20260306", +"revision": "20260330", "rootUrl": "https://cloudtasks.googleapis.com/", "schemas": { "AcknowledgeTaskRequest": { @@ -1555,6 +1584,41 @@ }, "type": "object" }, +"Operation": { +"description": "This resource represents a long-running operation that is the result of a network API call.", +"id": "Operation", +"properties": { +"done": { +"description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", +"type": "boolean" +}, +"error": { +"$ref": "Status", +"description": "The error result of the operation in case of failure or cancellation." +}, +"metadata": { +"additionalProperties": { +"description": "Properties of the object. Contains field @type with type URL.", +"type": "any" +}, +"description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", +"type": "object" +}, +"name": { +"description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", +"type": "string" +}, +"response": { +"additionalProperties": { +"description": "Properties of the object. Contains field @type with type URL.", +"type": "any" +}, +"description": "The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", +"type": "object" +} +}, +"type": "object" +}, "PathOverride": { "description": "PathOverride. Path message defines path override for HTTP targets.", "id": "PathOverride", diff --git a/googleapiclient/discovery_cache/documents/cloudtasks.v2beta3.json b/googleapiclient/discovery_cache/documents/cloudtasks.v2beta3.json index ecb99093a1..4186247972 100644 --- a/googleapiclient/discovery_cache/documents/cloudtasks.v2beta3.json +++ b/googleapiclient/discovery_cache/documents/cloudtasks.v2beta3.json @@ -160,7 +160,7 @@ ] }, "list": { -"description": "Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.", +"description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "flatPath": "v2beta3/projects/{projectsId}/locations", "httpMethod": "GET", "id": "cloudtasks.projects.locations.list", @@ -797,7 +797,7 @@ } } }, -"revision": "20260306", +"revision": "20260330", "rootUrl": "https://cloudtasks.googleapis.com/", "schemas": { "AppEngineHttpQueue": { diff --git a/googleapiclient/discovery_cache/documents/compute.alpha.json b/googleapiclient/discovery_cache/documents/compute.alpha.json index 4d9af0e8d6..245112d08e 100644 --- a/googleapiclient/discovery_cache/documents/compute.alpha.json +++ b/googleapiclient/discovery_cache/documents/compute.alpha.json @@ -54919,7 +54919,7 @@ } } }, -"revision": "20260320", +"revision": "20260331", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -60983,7 +60983,7 @@ false }, "snapshotGroupParameters": { "$ref": "SnapshotGroupParameters", -"description": "The parameters for the snapshot group." +"description": "The parameters for the snapshot group. The usage of snapshot group feature\nis restricted." }, "sourceConsistencyGroupPolicy": { "description": "The URL of the DiskConsistencyGroupPolicy for the group of disks to clone.\nThis may be a full or partial URL, such as:\n \n \n - \n https://www.googleapis.com/compute/v1/projects/project/regions/region/resourcePolicies/resourcePolicy\n \n - \n projects/project/regions/region/resourcePolicies/resourcePolicy\n \n - \n regions/region/resourcePolicies/resourcePolicy", @@ -103172,12 +103172,12 @@ false "description": "Encrypts the snapshot using acustomer-supplied\nencryption key.\n\nAfter you encrypt a snapshot using a customer-supplied key, you must\nprovide the same key if you use the snapshot later. For example, you must\nprovide the encryption key when you create a disk from the encrypted\nsnapshot in a future request.\n\nCustomer-supplied encryption keys do not protect access to metadata\nof the snapshot.\n\nIf you do not provide an encryption key when creating the snapshot, then\nthe snapshot will be encrypted using an automatically generated key and\nyou do not need to provide a key to use the snapshot later." }, "snapshotGroupId": { -"description": "Output only. [Output Only] The unique ID of the snapshot group that this snapshot\nbelongs to.", +"description": "Output only. [Output Only] The unique ID of the snapshot group that this snapshot\nbelongs to. The usage of snapshot group feature is restricted.", "readOnly": true, "type": "string" }, "snapshotGroupName": { -"description": "Output only. [Output only] The snapshot group that this snapshot belongs to.", +"description": "Output only. [Output only] The snapshot group that this snapshot belongs to. The usage\nof snapshot group feature is restricted.", "readOnly": true, "type": "string" }, @@ -116257,12 +116257,12 @@ false "description": "Encrypts the snapshot using acustomer-supplied\nencryption key.\n\nAfter you encrypt a snapshot using a customer-supplied key, you must\nprovide the same key if you use the snapshot later. For example, you must\nprovide the encryption key when you create a disk from the encrypted\nsnapshot in a future request.\n\nCustomer-supplied encryption keys do not protect access to metadata\nof the snapshot.\n\nIf you do not provide an encryption key when creating the snapshot, then\nthe snapshot will be encrypted using an automatically generated key and you\ndo not need to provide a key to use the snapshot later." }, "snapshotGroupId": { -"description": "Output only. [Output Only] The unique ID of the snapshot group that this snapshot\nbelongs to.", +"description": "Output only. [Output Only] The unique ID of the snapshot group that this snapshot\nbelongs to. The usage of snapshot group feature is restricted.", "readOnly": true, "type": "string" }, "snapshotGroupName": { -"description": "Output only. [Output only] The snapshot group that this snapshot belongs to.", +"description": "Output only. [Output only] The snapshot group that this snapshot belongs to. The usage\nof snapshot group feature is restricted.", "readOnly": true, "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/compute.beta.json b/googleapiclient/discovery_cache/documents/compute.beta.json index ef569a50ee..f978bd3e83 100644 --- a/googleapiclient/discovery_cache/documents/compute.beta.json +++ b/googleapiclient/discovery_cache/documents/compute.beta.json @@ -51573,7 +51573,7 @@ } } }, -"revision": "20260320", +"revision": "20260331", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -57389,7 +57389,7 @@ false }, "snapshotGroupParameters": { "$ref": "SnapshotGroupParameters", -"description": "The parameters for the snapshot group." +"description": "The parameters for the snapshot group. The usage of snapshot group feature\nis restricted." }, "sourceConsistencyGroupPolicy": { "description": "The URL of the DiskConsistencyGroupPolicy for the group of disks to clone.\nThis may be a full or partial URL, such as:\n \n \n - \n https://www.googleapis.com/compute/v1/projects/project/regions/region/resourcePolicies/resourcePolicy\n \n - \n projects/project/regions/region/resourcePolicies/resourcePolicy\n \n - \n regions/region/resourcePolicies/resourcePolicy", @@ -105529,12 +105529,12 @@ false "description": "Encrypts the snapshot using acustomer-supplied\nencryption key.\n\nAfter you encrypt a snapshot using a customer-supplied key, you must\nprovide the same key if you use the snapshot later. For example, you must\nprovide the encryption key when you create a disk from the encrypted\nsnapshot in a future request.\n\nCustomer-supplied encryption keys do not protect access to metadata\nof the snapshot.\n\nIf you do not provide an encryption key when creating the snapshot, then\nthe snapshot will be encrypted using an automatically generated key and you\ndo not need to provide a key to use the snapshot later." }, "snapshotGroupId": { -"description": "Output only. [Output Only] The unique ID of the snapshot group that this snapshot\nbelongs to.", +"description": "Output only. [Output Only] The unique ID of the snapshot group that this snapshot\nbelongs to. The usage of snapshot group feature is restricted.", "readOnly": true, "type": "string" }, "snapshotGroupName": { -"description": "Output only. [Output only] The snapshot group that this snapshot belongs to.", +"description": "Output only. [Output only] The snapshot group that this snapshot belongs to. The usage\nof snapshot group feature is restricted.", "readOnly": true, "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/compute.v1.json b/googleapiclient/discovery_cache/documents/compute.v1.json index cd1e51d1e6..b8323582be 100644 --- a/googleapiclient/discovery_cache/documents/compute.v1.json +++ b/googleapiclient/discovery_cache/documents/compute.v1.json @@ -10917,21 +10917,6 @@ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "required": true, "type": "string" -}, -"view": { -"description": "View of the instance template.", -"enum": [ -"BASIC", -"FULL", -"INSTANCE_VIEW_UNSPECIFIED" -], -"enumDescriptions": [ -"Include everything except Partner Metadata.", -"Include everything.", -"The default / unset value. The API will default to the BASIC view." -], -"location": "query", -"type": "string" } }, "path": "projects/{project}/global/instanceTemplates/{instanceTemplate}", @@ -11062,21 +11047,6 @@ "description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.", "location": "query", "type": "boolean" -}, -"view": { -"description": "View of the instance template.", -"enum": [ -"BASIC", -"FULL", -"INSTANCE_VIEW_UNSPECIFIED" -], -"enumDescriptions": [ -"Include everything except Partner Metadata.", -"Include everything.", -"The default / unset value. The API will default to the BASIC view." -], -"location": "query", -"type": "string" } }, "path": "projects/{project}/global/instanceTemplates", @@ -11727,21 +11697,6 @@ "required": true, "type": "string" }, -"view": { -"description": "View of the instance.", -"enum": [ -"BASIC", -"FULL", -"INSTANCE_VIEW_UNSPECIFIED" -], -"enumDescriptions": [ -"Include everything except Partner Metadata.", -"Include everything.", -"The default / unset value. The API will default to the BASIC view." -], -"location": "query", -"type": "string" -}, "zone": { "description": "The name of the zone for this request.", "location": "path", @@ -11912,54 +11867,6 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, -"getPartnerMetadata": { -"description": "Gets partner metadata of the specified instance and namespaces.", -"flatPath": "projects/{project}/zones/{zone}/instances/{instance}/getPartnerMetadata", -"httpMethod": "GET", -"id": "compute.instances.getPartnerMetadata", -"parameterOrder": [ -"project", -"zone", -"instance" -], -"parameters": { -"instance": { -"description": "Name of the instance scoping this request.", -"location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", -"required": true, -"type": "string" -}, -"namespaces": { -"description": "Comma separated partner metadata namespaces.", -"location": "query", -"type": "string" -}, -"project": { -"description": "Project ID for this request.", -"location": "path", -"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", -"required": true, -"type": "string" -}, -"zone": { -"description": "The name of the zone for this request.", -"location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", -"required": true, -"type": "string" -} -}, -"path": "projects/{project}/zones/{zone}/instances/{instance}/getPartnerMetadata", -"response": { -"$ref": "PartnerMetadata" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute", -"https://www.googleapis.com/auth/compute.readonly" -] -}, "getScreenshot": { "description": "Returns the screenshot from the specified instance.", "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/screenshot", @@ -12201,21 +12108,6 @@ "location": "query", "type": "boolean" }, -"view": { -"description": "View of the instance.", -"enum": [ -"BASIC", -"FULL", -"INSTANCE_VIEW_UNSPECIFIED" -], -"enumDescriptions": [ -"Include everything except Partner Metadata.", -"Include everything.", -"The default / unset value. The API will default to the BASIC view." -], -"location": "query", -"type": "string" -}, "zone": { "description": "The name of the zone for this request.", "location": "path", @@ -12305,56 +12197,6 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, -"patchPartnerMetadata": { -"description": "Patches partner metadata of the specified instance.", -"flatPath": "projects/{project}/zones/{zone}/instances/{instance}/patchPartnerMetadata", -"httpMethod": "POST", -"id": "compute.instances.patchPartnerMetadata", -"parameterOrder": [ -"project", -"zone", -"instance" -], -"parameters": { -"instance": { -"description": "Name of the instance scoping this request.", -"location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", -"required": true, -"type": "string" -}, -"project": { -"description": "Project ID for this request.", -"location": "path", -"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", -"required": true, -"type": "string" -}, -"requestId": { -"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).", -"location": "query", -"type": "string" -}, -"zone": { -"description": "The name of the zone for this request.", -"location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", -"required": true, -"type": "string" -} -}, -"path": "projects/{project}/zones/{zone}/instances/{instance}/patchPartnerMetadata", -"request": { -"$ref": "PartnerMetadata" -}, -"response": { -"$ref": "Operation" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute" -] -}, "performMaintenance": { "description": "Perform a manual maintenance on the instance.", "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/performMaintenance", @@ -13948,86 +13790,20 @@ } } }, -"instantSnapshots": { +"instantSnapshotGroups": { "methods": { -"aggregatedList": { -"description": "Retrieves an aggregated list of instantSnapshots.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.", -"flatPath": "projects/{project}/aggregated/instantSnapshots", -"httpMethod": "GET", -"id": "compute.instantSnapshots.aggregatedList", -"parameterOrder": [ -"project" -], -"parameters": { -"filter": { -"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.", -"location": "query", -"type": "string" -}, -"includeAllScopes": { -"description": "Indicates whether every visible scope for each scope type (zone, region,\nglobal) should be included in the response. For new resource types added\nafter this field, the flag has no effect as new resource types will always\ninclude every visible scope for each scope type in response. For resource\ntypes which predate this field, if this flag is omitted or false, only\nscopes of the scope types where the resource type is expected to be found\nwill be included.", -"location": "query", -"type": "boolean" -}, -"maxResults": { -"default": "500", -"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`0` to `500`, inclusive. (Default: `500`)", -"format": "uint32", -"location": "query", -"minimum": "0", -"type": "integer" -}, -"orderBy": { -"description": "Sorts list results by a certain order. By default, results\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.", -"location": "query", -"type": "string" -}, -"pageToken": { -"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe next page of results.", -"location": "query", -"type": "string" -}, -"project": { -"description": "Project ID for this request.", -"location": "path", -"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", -"required": true, -"type": "string" -}, -"returnPartialSuccess": { -"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.", -"location": "query", -"type": "boolean" -}, -"serviceProjectNumber": { -"description": "The Shared VPC service project id or service project number for which\naggregated list request is invoked for subnetworks list-usable api.", -"format": "int64", -"location": "query", -"type": "string" -} -}, -"path": "projects/{project}/aggregated/instantSnapshots", -"response": { -"$ref": "InstantSnapshotAggregatedList" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute", -"https://www.googleapis.com/auth/compute.readonly" -] -}, "delete": { -"description": "Deletes the specified InstantSnapshot resource. Keep in mind that deleting\na single instantSnapshot might not necessarily delete all the data on that\ninstantSnapshot. If any data on the instantSnapshot that is marked for\ndeletion is needed for subsequent instantSnapshots, the data will be moved\nto the next corresponding instantSnapshot.\n\nFor more information, seeDeleting\ninstantSnapshots.", -"flatPath": "projects/{project}/zones/{zone}/instantSnapshots/{instantSnapshot}", +"description": "deletes a Zonal InstantSnapshotGroup resource", +"flatPath": "projects/{project}/zones/{zone}/instantSnapshotGroups/{instantSnapshotGroup}", "httpMethod": "DELETE", -"id": "compute.instantSnapshots.delete", +"id": "compute.instantSnapshotGroups.delete", "parameterOrder": [ "project", "zone", -"instantSnapshot" +"instantSnapshotGroup" ], "parameters": { -"instantSnapshot": { +"instantSnapshotGroup": { "description": "Name of the InstantSnapshot resource to delete.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", @@ -14054,7 +13830,7 @@ "type": "string" } }, -"path": "projects/{project}/zones/{zone}/instantSnapshots/{instantSnapshot}", +"path": "projects/{project}/zones/{zone}/instantSnapshotGroups/{instantSnapshotGroup}", "response": { "$ref": "Operation" }, @@ -14064,18 +13840,18 @@ ] }, "get": { -"description": "Returns the specified InstantSnapshot resource in the specified zone.", -"flatPath": "projects/{project}/zones/{zone}/instantSnapshots/{instantSnapshot}", +"description": "returns the specified InstantSnapshotGroup resource in the specified zone.", +"flatPath": "projects/{project}/zones/{zone}/instantSnapshotGroups/{instantSnapshotGroup}", "httpMethod": "GET", -"id": "compute.instantSnapshots.get", +"id": "compute.instantSnapshotGroups.get", "parameterOrder": [ "project", "zone", -"instantSnapshot" +"instantSnapshotGroup" ], "parameters": { -"instantSnapshot": { -"description": "Name of the InstantSnapshot resource to return.", +"instantSnapshotGroup": { +"description": "Name of the InstantSnapshotGroup resource to return.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, @@ -14096,9 +13872,9 @@ "type": "string" } }, -"path": "projects/{project}/zones/{zone}/instantSnapshots/{instantSnapshot}", +"path": "projects/{project}/zones/{zone}/instantSnapshotGroups/{instantSnapshotGroup}", "response": { -"$ref": "InstantSnapshot" +"$ref": "InstantSnapshotGroup" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -14108,9 +13884,9 @@ }, "getIamPolicy": { "description": "Gets the access control policy for a resource. May be empty if no such\npolicy or resource exists.", -"flatPath": "projects/{project}/zones/{zone}/instantSnapshots/{resource}/getIamPolicy", +"flatPath": "projects/{project}/zones/{zone}/instantSnapshotGroups/{resource}/getIamPolicy", "httpMethod": "GET", -"id": "compute.instantSnapshots.getIamPolicy", +"id": "compute.instantSnapshotGroups.getIamPolicy", "parameterOrder": [ "project", "zone", @@ -14145,7 +13921,7 @@ "type": "string" } }, -"path": "projects/{project}/zones/{zone}/instantSnapshots/{resource}/getIamPolicy", +"path": "projects/{project}/zones/{zone}/instantSnapshotGroups/{resource}/getIamPolicy", "response": { "$ref": "Policy" }, @@ -14156,10 +13932,10 @@ ] }, "insert": { -"description": "Creates an instant snapshot in the specified zone.", -"flatPath": "projects/{project}/zones/{zone}/instantSnapshots", +"description": "inserts a Zonal InstantSnapshotGroup resource", +"flatPath": "projects/{project}/zones/{zone}/instantSnapshotGroups", "httpMethod": "POST", -"id": "compute.instantSnapshots.insert", +"id": "compute.instantSnapshotGroups.insert", "parameterOrder": [ "project", "zone" @@ -14177,6 +13953,11 @@ "location": "query", "type": "string" }, +"sourceConsistencyGroup": { +"description": "begin_interface: MixerMutationRequestBuilder", +"location": "query", +"type": "string" +}, "zone": { "description": "Name of the zone for this request.", "location": "path", @@ -14185,9 +13966,9 @@ "type": "string" } }, -"path": "projects/{project}/zones/{zone}/instantSnapshots", +"path": "projects/{project}/zones/{zone}/instantSnapshotGroups", "request": { -"$ref": "InstantSnapshot" +"$ref": "InstantSnapshotGroup" }, "response": { "$ref": "Operation" @@ -14198,10 +13979,10 @@ ] }, "list": { -"description": "Retrieves the list of InstantSnapshot resources contained within\nthe specified zone.", -"flatPath": "projects/{project}/zones/{zone}/instantSnapshots", +"description": "retrieves the list of InstantSnapshotGroup resources contained within\nthe specified zone.", +"flatPath": "projects/{project}/zones/{zone}/instantSnapshotGroups", "httpMethod": "GET", -"id": "compute.instantSnapshots.list", +"id": "compute.instantSnapshotGroups.list", "parameterOrder": [ "project", "zone" @@ -14250,9 +14031,9 @@ "type": "string" } }, -"path": "projects/{project}/zones/{zone}/instantSnapshots", +"path": "projects/{project}/zones/{zone}/instantSnapshotGroups", "response": { -"$ref": "InstantSnapshotList" +"$ref": "ListInstantSnapshotGroups" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -14262,9 +14043,9 @@ }, "setIamPolicy": { "description": "Sets the access control policy on the specified resource.\nReplaces any existing policy.", -"flatPath": "projects/{project}/zones/{zone}/instantSnapshots/{resource}/setIamPolicy", +"flatPath": "projects/{project}/zones/{zone}/instantSnapshotGroups/{resource}/setIamPolicy", "httpMethod": "POST", -"id": "compute.instantSnapshots.setIamPolicy", +"id": "compute.instantSnapshotGroups.setIamPolicy", "parameterOrder": [ "project", "zone", @@ -14293,7 +14074,7 @@ "type": "string" } }, -"path": "projects/{project}/zones/{zone}/instantSnapshots/{resource}/setIamPolicy", +"path": "projects/{project}/zones/{zone}/instantSnapshotGroups/{resource}/setIamPolicy", "request": { "$ref": "ZoneSetPolicyRequest" }, @@ -14305,61 +14086,466 @@ "https://www.googleapis.com/auth/compute" ] }, -"setLabels": { -"description": "Sets the labels on a instantSnapshot in the given zone. To learn more about\nlabels, read the Labeling\nResources documentation.", -"flatPath": "projects/{project}/zones/{zone}/instantSnapshots/{resource}/setLabels", -"httpMethod": "POST", -"id": "compute.instantSnapshots.setLabels", -"parameterOrder": [ -"project", -"zone", -"resource" -], -"parameters": { -"project": { -"description": "Project ID for this request.", -"location": "path", -"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", -"required": true, -"type": "string" -}, -"requestId": { -"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).", -"location": "query", -"type": "string" -}, -"resource": { -"description": "Name or id of the resource for this request.", -"location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", -"required": true, -"type": "string" -}, -"zone": { -"description": "The name of the zone for this request.", -"location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", -"required": true, -"type": "string" -} -}, -"path": "projects/{project}/zones/{zone}/instantSnapshots/{resource}/setLabels", -"request": { -"$ref": "ZoneSetLabelsRequest" -}, -"response": { -"$ref": "Operation" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute" -] -}, "testIamPermissions": { "description": "Returns permissions that a caller has on the specified resource.", -"flatPath": "projects/{project}/zones/{zone}/instantSnapshots/{resource}/testIamPermissions", +"flatPath": "projects/{project}/zones/{zone}/instantSnapshotGroups/{resource}/testIamPermissions", "httpMethod": "POST", -"id": "compute.instantSnapshots.testIamPermissions", +"id": "compute.instantSnapshotGroups.testIamPermissions", +"parameterOrder": [ +"project", +"zone", +"resource" +], +"parameters": { +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"resource": { +"description": "Name or id of the resource for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +}, +"zone": { +"description": "The name of the zone for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/zones/{zone}/instantSnapshotGroups/{resource}/testIamPermissions", +"request": { +"$ref": "TestPermissionsRequest" +}, +"response": { +"$ref": "TestPermissionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +} +} +}, +"instantSnapshots": { +"methods": { +"aggregatedList": { +"description": "Retrieves an aggregated list of instantSnapshots.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.", +"flatPath": "projects/{project}/aggregated/instantSnapshots", +"httpMethod": "GET", +"id": "compute.instantSnapshots.aggregatedList", +"parameterOrder": [ +"project" +], +"parameters": { +"filter": { +"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.", +"location": "query", +"type": "string" +}, +"includeAllScopes": { +"description": "Indicates whether every visible scope for each scope type (zone, region,\nglobal) should be included in the response. For new resource types added\nafter this field, the flag has no effect as new resource types will always\ninclude every visible scope for each scope type in response. For resource\ntypes which predate this field, if this flag is omitted or false, only\nscopes of the scope types where the resource type is expected to be found\nwill be included.", +"location": "query", +"type": "boolean" +}, +"maxResults": { +"default": "500", +"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`0` to `500`, inclusive. (Default: `500`)", +"format": "uint32", +"location": "query", +"minimum": "0", +"type": "integer" +}, +"orderBy": { +"description": "Sorts list results by a certain order. By default, results\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.", +"location": "query", +"type": "string" +}, +"pageToken": { +"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe next page of results.", +"location": "query", +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"returnPartialSuccess": { +"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.", +"location": "query", +"type": "boolean" +}, +"serviceProjectNumber": { +"description": "The Shared VPC service project id or service project number for which\naggregated list request is invoked for subnetworks list-usable api.", +"format": "int64", +"location": "query", +"type": "string" +} +}, +"path": "projects/{project}/aggregated/instantSnapshots", +"response": { +"$ref": "InstantSnapshotAggregatedList" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, +"delete": { +"description": "Deletes the specified InstantSnapshot resource. Keep in mind that deleting\na single instantSnapshot might not necessarily delete all the data on that\ninstantSnapshot. If any data on the instantSnapshot that is marked for\ndeletion is needed for subsequent instantSnapshots, the data will be moved\nto the next corresponding instantSnapshot.\n\nFor more information, seeDeleting\ninstantSnapshots.", +"flatPath": "projects/{project}/zones/{zone}/instantSnapshots/{instantSnapshot}", +"httpMethod": "DELETE", +"id": "compute.instantSnapshots.delete", +"parameterOrder": [ +"project", +"zone", +"instantSnapshot" +], +"parameters": { +"instantSnapshot": { +"description": "Name of the InstantSnapshot resource to delete.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"zone": { +"description": "The name of the zone for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/zones/{zone}/instantSnapshots/{instantSnapshot}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, +"get": { +"description": "Returns the specified InstantSnapshot resource in the specified zone.", +"flatPath": "projects/{project}/zones/{zone}/instantSnapshots/{instantSnapshot}", +"httpMethod": "GET", +"id": "compute.instantSnapshots.get", +"parameterOrder": [ +"project", +"zone", +"instantSnapshot" +], +"parameters": { +"instantSnapshot": { +"description": "Name of the InstantSnapshot resource to return.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"zone": { +"description": "The name of the zone for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/zones/{zone}/instantSnapshots/{instantSnapshot}", +"response": { +"$ref": "InstantSnapshot" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, +"getIamPolicy": { +"description": "Gets the access control policy for a resource. May be empty if no such\npolicy or resource exists.", +"flatPath": "projects/{project}/zones/{zone}/instantSnapshots/{resource}/getIamPolicy", +"httpMethod": "GET", +"id": "compute.instantSnapshots.getIamPolicy", +"parameterOrder": [ +"project", +"zone", +"resource" +], +"parameters": { +"optionsRequestedPolicyVersion": { +"description": "Requested IAM Policy version.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"resource": { +"description": "Name or id of the resource for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +}, +"zone": { +"description": "The name of the zone for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/zones/{zone}/instantSnapshots/{resource}/getIamPolicy", +"response": { +"$ref": "Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, +"insert": { +"description": "Creates an instant snapshot in the specified zone.", +"flatPath": "projects/{project}/zones/{zone}/instantSnapshots", +"httpMethod": "POST", +"id": "compute.instantSnapshots.insert", +"parameterOrder": [ +"project", +"zone" +], +"parameters": { +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"zone": { +"description": "Name of the zone for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/zones/{zone}/instantSnapshots", +"request": { +"$ref": "InstantSnapshot" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, +"list": { +"description": "Retrieves the list of InstantSnapshot resources contained within\nthe specified zone.", +"flatPath": "projects/{project}/zones/{zone}/instantSnapshots", +"httpMethod": "GET", +"id": "compute.instantSnapshots.list", +"parameterOrder": [ +"project", +"zone" +], +"parameters": { +"filter": { +"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.", +"location": "query", +"type": "string" +}, +"maxResults": { +"default": "500", +"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`0` to `500`, inclusive. (Default: `500`)", +"format": "uint32", +"location": "query", +"minimum": "0", +"type": "integer" +}, +"orderBy": { +"description": "Sorts list results by a certain order. By default, results\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.", +"location": "query", +"type": "string" +}, +"pageToken": { +"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe next page of results.", +"location": "query", +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"returnPartialSuccess": { +"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.", +"location": "query", +"type": "boolean" +}, +"zone": { +"description": "The name of the zone for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/zones/{zone}/instantSnapshots", +"response": { +"$ref": "InstantSnapshotList" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, +"setIamPolicy": { +"description": "Sets the access control policy on the specified resource.\nReplaces any existing policy.", +"flatPath": "projects/{project}/zones/{zone}/instantSnapshots/{resource}/setIamPolicy", +"httpMethod": "POST", +"id": "compute.instantSnapshots.setIamPolicy", +"parameterOrder": [ +"project", +"zone", +"resource" +], +"parameters": { +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"resource": { +"description": "Name or id of the resource for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +}, +"zone": { +"description": "The name of the zone for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/zones/{zone}/instantSnapshots/{resource}/setIamPolicy", +"request": { +"$ref": "ZoneSetPolicyRequest" +}, +"response": { +"$ref": "Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, +"setLabels": { +"description": "Sets the labels on a instantSnapshot in the given zone. To learn more about\nlabels, read the Labeling\nResources documentation.", +"flatPath": "projects/{project}/zones/{zone}/instantSnapshots/{resource}/setLabels", +"httpMethod": "POST", +"id": "compute.instantSnapshots.setLabels", +"parameterOrder": [ +"project", +"zone", +"resource" +], +"parameters": { +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"resource": { +"description": "Name or id of the resource for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +}, +"zone": { +"description": "The name of the zone for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/zones/{zone}/instantSnapshots/{resource}/setLabels", +"request": { +"$ref": "ZoneSetLabelsRequest" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, +"testIamPermissions": { +"description": "Returns permissions that a caller has on the specified resource.", +"flatPath": "projects/{project}/zones/{zone}/instantSnapshots/{resource}/testIamPermissions", +"httpMethod": "POST", +"id": "compute.instantSnapshots.testIamPermissions", "parameterOrder": [ "project", "zone", @@ -29677,21 +29863,6 @@ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" -}, -"view": { -"description": "View of the instance template.", -"enum": [ -"BASIC", -"FULL", -"INSTANCE_VIEW_UNSPECIFIED" -], -"enumDescriptions": [ -"Include everything except Partner Metadata.", -"Include everything.", -"The default / unset value. The API will default to the BASIC view." -], -"location": "query", -"type": "string" } }, "path": "projects/{project}/regions/{region}/instanceTemplates/{instanceTemplate}", @@ -29797,21 +29968,6 @@ "description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.", "location": "query", "type": "boolean" -}, -"view": { -"description": "View of the instance template.", -"enum": [ -"BASIC", -"FULL", -"INSTANCE_VIEW_UNSPECIFIED" -], -"enumDescriptions": [ -"Include everything except Partner Metadata.", -"Include everything.", -"The default / unset value. The API will default to the BASIC view." -], -"location": "query", -"type": "string" } }, "path": "projects/{project}/regions/{region}/instanceTemplates", @@ -29872,21 +30028,21 @@ } } }, -"regionInstantSnapshots": { +"regionInstantSnapshotGroups": { "methods": { "delete": { -"description": "Deletes the specified InstantSnapshot resource. Keep in mind that deleting\na single instantSnapshot might not necessarily delete all the data on that\ninstantSnapshot. If any data on the instantSnapshot that is marked for\ndeletion is needed for subsequent instantSnapshots, the data will be moved\nto the next corresponding instantSnapshot.\n\nFor more information, seeDeleting\ninstantSnapshots.", -"flatPath": "projects/{project}/regions/{region}/instantSnapshots/{instantSnapshot}", +"description": "deletes a Regional InstantSnapshotGroup resource", +"flatPath": "projects/{project}/regions/{region}/instantSnapshotGroups/{instantSnapshotGroup}", "httpMethod": "DELETE", -"id": "compute.regionInstantSnapshots.delete", +"id": "compute.regionInstantSnapshotGroups.delete", "parameterOrder": [ "project", "region", -"instantSnapshot" +"instantSnapshotGroup" ], "parameters": { -"instantSnapshot": { -"description": "Name of the InstantSnapshot resource to delete.", +"instantSnapshotGroup": { +"description": "Name of the InstantSnapshotGroup resource to delete.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, @@ -29912,7 +30068,7 @@ "type": "string" } }, -"path": "projects/{project}/regions/{region}/instantSnapshots/{instantSnapshot}", +"path": "projects/{project}/regions/{region}/instantSnapshotGroups/{instantSnapshotGroup}", "response": { "$ref": "Operation" }, @@ -29922,18 +30078,18 @@ ] }, "get": { -"description": "Returns the specified InstantSnapshot resource in the specified region.", -"flatPath": "projects/{project}/regions/{region}/instantSnapshots/{instantSnapshot}", +"description": "returns the specified InstantSnapshotGroup resource in the specified\nregion.", +"flatPath": "projects/{project}/regions/{region}/instantSnapshotGroups/{instantSnapshotGroup}", "httpMethod": "GET", -"id": "compute.regionInstantSnapshots.get", +"id": "compute.regionInstantSnapshotGroups.get", "parameterOrder": [ "project", "region", -"instantSnapshot" +"instantSnapshotGroup" ], "parameters": { -"instantSnapshot": { -"description": "Name of the InstantSnapshot resource to return.", +"instantSnapshotGroup": { +"description": "Name of the InstantSnapshotGroup resource to return.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, @@ -29954,9 +30110,9 @@ "type": "string" } }, -"path": "projects/{project}/regions/{region}/instantSnapshots/{instantSnapshot}", +"path": "projects/{project}/regions/{region}/instantSnapshotGroups/{instantSnapshotGroup}", "response": { -"$ref": "InstantSnapshot" +"$ref": "InstantSnapshotGroup" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -29966,9 +30122,9 @@ }, "getIamPolicy": { "description": "Gets the access control policy for a resource. May be empty if no such\npolicy or resource exists.", -"flatPath": "projects/{project}/regions/{region}/instantSnapshots/{resource}/getIamPolicy", +"flatPath": "projects/{project}/regions/{region}/instantSnapshotGroups/{resource}/getIamPolicy", "httpMethod": "GET", -"id": "compute.regionInstantSnapshots.getIamPolicy", +"id": "compute.regionInstantSnapshotGroups.getIamPolicy", "parameterOrder": [ "project", "region", @@ -30003,7 +30159,7 @@ "type": "string" } }, -"path": "projects/{project}/regions/{region}/instantSnapshots/{resource}/getIamPolicy", +"path": "projects/{project}/regions/{region}/instantSnapshotGroups/{resource}/getIamPolicy", "response": { "$ref": "Policy" }, @@ -30014,10 +30170,10 @@ ] }, "insert": { -"description": "Creates an instant snapshot in the specified region.", -"flatPath": "projects/{project}/regions/{region}/instantSnapshots", +"description": "creates a Regional InstantSnapshotGroup resource", +"flatPath": "projects/{project}/regions/{region}/instantSnapshotGroups", "httpMethod": "POST", -"id": "compute.regionInstantSnapshots.insert", +"id": "compute.regionInstantSnapshotGroups.insert", "parameterOrder": [ "project", "region" @@ -30041,11 +30197,16 @@ "description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" +}, +"sourceConsistencyGroup": { +"description": "begin_interface: MixerMutationRequestBuilder", +"location": "query", +"type": "string" } }, -"path": "projects/{project}/regions/{region}/instantSnapshots", +"path": "projects/{project}/regions/{region}/instantSnapshotGroups", "request": { -"$ref": "InstantSnapshot" +"$ref": "InstantSnapshotGroup" }, "response": { "$ref": "Operation" @@ -30056,10 +30217,10 @@ ] }, "list": { -"description": "Retrieves the list of InstantSnapshot resources contained within\nthe specified region.", -"flatPath": "projects/{project}/regions/{region}/instantSnapshots", +"description": "retrieves the list of InstantSnapshotGroup resources contained within\nthe specified region.", +"flatPath": "projects/{project}/regions/{region}/instantSnapshotGroups", "httpMethod": "GET", -"id": "compute.regionInstantSnapshots.list", +"id": "compute.regionInstantSnapshotGroups.list", "parameterOrder": [ "project", "region" @@ -30108,9 +30269,9 @@ "type": "boolean" } }, -"path": "projects/{project}/regions/{region}/instantSnapshots", +"path": "projects/{project}/regions/{region}/instantSnapshotGroups", "response": { -"$ref": "InstantSnapshotList" +"$ref": "ListInstantSnapshotGroups" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -30120,9 +30281,9 @@ }, "setIamPolicy": { "description": "Sets the access control policy on the specified resource.\nReplaces any existing policy.", -"flatPath": "projects/{project}/regions/{region}/instantSnapshots/{resource}/setIamPolicy", +"flatPath": "projects/{project}/regions/{region}/instantSnapshotGroups/{resource}/setIamPolicy", "httpMethod": "POST", -"id": "compute.regionInstantSnapshots.setIamPolicy", +"id": "compute.regionInstantSnapshotGroups.setIamPolicy", "parameterOrder": [ "project", "region", @@ -30151,7 +30312,7 @@ "type": "string" } }, -"path": "projects/{project}/regions/{region}/instantSnapshots/{resource}/setIamPolicy", +"path": "projects/{project}/regions/{region}/instantSnapshotGroups/{resource}/setIamPolicy", "request": { "$ref": "RegionSetPolicyRequest" }, @@ -30163,61 +30324,11 @@ "https://www.googleapis.com/auth/compute" ] }, -"setLabels": { -"description": "Sets the labels on a instantSnapshot in the given region. To learn more\nabout labels, read the Labeling\nResources documentation.", -"flatPath": "projects/{project}/regions/{region}/instantSnapshots/{resource}/setLabels", -"httpMethod": "POST", -"id": "compute.regionInstantSnapshots.setLabels", -"parameterOrder": [ -"project", -"region", -"resource" -], -"parameters": { -"project": { -"description": "Project ID for this request.", -"location": "path", -"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", -"required": true, -"type": "string" -}, -"region": { -"description": "The region for this request.", -"location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", -"required": true, -"type": "string" -}, -"requestId": { -"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).", -"location": "query", -"type": "string" -}, -"resource": { -"description": "Name or id of the resource for this request.", -"location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", -"required": true, -"type": "string" -} -}, -"path": "projects/{project}/regions/{region}/instantSnapshots/{resource}/setLabels", -"request": { -"$ref": "RegionSetLabelsRequest" -}, -"response": { -"$ref": "Operation" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute" -] -}, "testIamPermissions": { "description": "Returns permissions that a caller has on the specified resource.", -"flatPath": "projects/{project}/regions/{region}/instantSnapshots/{resource}/testIamPermissions", +"flatPath": "projects/{project}/regions/{region}/instantSnapshotGroups/{resource}/testIamPermissions", "httpMethod": "POST", -"id": "compute.regionInstantSnapshots.testIamPermissions", +"id": "compute.regionInstantSnapshotGroups.testIamPermissions", "parameterOrder": [ "project", "region", @@ -30246,7 +30357,7 @@ "type": "string" } }, -"path": "projects/{project}/regions/{region}/instantSnapshots/{resource}/testIamPermissions", +"path": "projects/{project}/regions/{region}/instantSnapshotGroups/{resource}/testIamPermissions", "request": { "$ref": "TestPermissionsRequest" }, @@ -30261,22 +30372,23 @@ } } }, -"regionNetworkEndpointGroups": { +"regionInstantSnapshots": { "methods": { -"attachNetworkEndpoints": { -"description": "Attach a list of network endpoints to the specified network endpoint group.", -"flatPath": "projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}/attachNetworkEndpoints", -"httpMethod": "POST", -"id": "compute.regionNetworkEndpointGroups.attachNetworkEndpoints", +"delete": { +"description": "Deletes the specified InstantSnapshot resource. Keep in mind that deleting\na single instantSnapshot might not necessarily delete all the data on that\ninstantSnapshot. If any data on the instantSnapshot that is marked for\ndeletion is needed for subsequent instantSnapshots, the data will be moved\nto the next corresponding instantSnapshot.\n\nFor more information, seeDeleting\ninstantSnapshots.", +"flatPath": "projects/{project}/regions/{region}/instantSnapshots/{instantSnapshot}", +"httpMethod": "DELETE", +"id": "compute.regionInstantSnapshots.delete", "parameterOrder": [ "project", "region", -"networkEndpointGroup" +"instantSnapshot" ], "parameters": { -"networkEndpointGroup": { -"description": "The name of the network endpoint group where you are attaching network\nendpoints to. It should comply with RFC1035.", +"instantSnapshot": { +"description": "Name of the InstantSnapshot resource to delete.", "location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" }, @@ -30288,8 +30400,9 @@ "type": "string" }, "region": { -"description": "The name of the region where\nyou want to create the network endpoint group. It should comply with\nRFC1035.", +"description": "The name of the region for this request.", "location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" }, @@ -30299,10 +30412,7 @@ "type": "string" } }, -"path": "projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}/attachNetworkEndpoints", -"request": { -"$ref": "RegionNetworkEndpointGroupsAttachEndpointsRequest" -}, +"path": "projects/{project}/regions/{region}/instantSnapshots/{instantSnapshot}", "response": { "$ref": "Operation" }, @@ -30311,20 +30421,21 @@ "https://www.googleapis.com/auth/compute" ] }, -"delete": { -"description": "Deletes the specified network endpoint group. Note that the NEG cannot be\ndeleted if it is configured as a backend of a backend service.", -"flatPath": "projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}", -"httpMethod": "DELETE", -"id": "compute.regionNetworkEndpointGroups.delete", +"get": { +"description": "Returns the specified InstantSnapshot resource in the specified region.", +"flatPath": "projects/{project}/regions/{region}/instantSnapshots/{instantSnapshot}", +"httpMethod": "GET", +"id": "compute.regionInstantSnapshots.get", "parameterOrder": [ "project", "region", -"networkEndpointGroup" +"instantSnapshot" ], "parameters": { -"networkEndpointGroup": { -"description": "The name of the network endpoint group to delete. It should comply with\nRFC1035.", +"instantSnapshot": { +"description": "Name of the InstantSnapshot resource to return.", "location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" }, @@ -30336,42 +30447,39 @@ "type": "string" }, "region": { -"description": "The name of the region where\nthe network endpoint group is located. It should comply with RFC1035.", +"description": "The name of the region for this request.", "location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" -}, -"requestId": { -"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).", -"location": "query", -"type": "string" } }, -"path": "projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}", +"path": "projects/{project}/regions/{region}/instantSnapshots/{instantSnapshot}", "response": { -"$ref": "Operation" +"$ref": "InstantSnapshot" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute" +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" ] }, -"detachNetworkEndpoints": { -"description": "Detach the network endpoint from the specified network endpoint group.", -"flatPath": "projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}/detachNetworkEndpoints", -"httpMethod": "POST", -"id": "compute.regionNetworkEndpointGroups.detachNetworkEndpoints", +"getIamPolicy": { +"description": "Gets the access control policy for a resource. May be empty if no such\npolicy or resource exists.", +"flatPath": "projects/{project}/regions/{region}/instantSnapshots/{resource}/getIamPolicy", +"httpMethod": "GET", +"id": "compute.regionInstantSnapshots.getIamPolicy", "parameterOrder": [ "project", "region", -"networkEndpointGroup" +"resource" ], "parameters": { -"networkEndpointGroup": { -"description": "The name of the network endpoint group you are detaching network\nendpoints from. It should comply with RFC1035.", -"location": "path", -"required": true, -"type": "string" +"optionsRequestedPolicyVersion": { +"description": "Requested IAM Policy version.", +"format": "int32", +"location": "query", +"type": "integer" }, "project": { "description": "Project ID for this request.", @@ -30381,63 +30489,23 @@ "type": "string" }, "region": { -"description": "The name of the region where\nthe network endpoint group is located. It should comply with\nRFC1035.", -"location": "path", -"required": true, -"type": "string" -}, -"requestId": { -"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).\nend_interface: MixerMutationRequestBuilder", -"location": "query", -"type": "string" -} -}, -"path": "projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}/detachNetworkEndpoints", -"request": { -"$ref": "RegionNetworkEndpointGroupsDetachEndpointsRequest" -}, -"response": { -"$ref": "Operation" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute" -] -}, -"get": { -"description": "Returns the specified network endpoint group.", -"flatPath": "projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}", -"httpMethod": "GET", -"id": "compute.regionNetworkEndpointGroups.get", -"parameterOrder": [ -"project", -"region", -"networkEndpointGroup" -], -"parameters": { -"networkEndpointGroup": { -"description": "The name of the network endpoint group. It should comply with RFC1035.", -"location": "path", -"required": true, -"type": "string" -}, -"project": { -"description": "Project ID for this request.", +"description": "The name of the region for this request.", "location": "path", -"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" }, -"region": { -"description": "The name of the region where\nthe network endpoint group is located. It should comply with RFC1035.", +"resource": { +"description": "Name or id of the resource for this request.", "location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, -"path": "projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}", +"path": "projects/{project}/regions/{region}/instantSnapshots/{resource}/getIamPolicy", "response": { -"$ref": "NetworkEndpointGroup" +"$ref": "Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -30446,10 +30514,10 @@ ] }, "insert": { -"description": "Creates a network endpoint group in the specified project using the\nparameters that are included in the request.\n\nNote: Use the following APIs to manage network endpoint groups:\n \n - \n To manage NEGs with zonal scope (such as zonal NEGs, hybrid connectivity\n NEGs): zonal\n API\n - \n To manage NEGs with regional scope (such as regional internet NEGs,\n serverless NEGs, Private Service Connect NEGs): regional\n API\n - \n To manage NEGs with global scope (such as global internet NEGs):global\n API", -"flatPath": "projects/{project}/regions/{region}/networkEndpointGroups", +"description": "Creates an instant snapshot in the specified region.", +"flatPath": "projects/{project}/regions/{region}/instantSnapshots", "httpMethod": "POST", -"id": "compute.regionNetworkEndpointGroups.insert", +"id": "compute.regionInstantSnapshots.insert", "parameterOrder": [ "project", "region" @@ -30463,8 +30531,9 @@ "type": "string" }, "region": { -"description": "The name of the region where\nyou want to create the network endpoint group. It should comply with\nRFC1035.", +"description": "Name of the region for this request.", "location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" }, @@ -30474,9 +30543,9 @@ "type": "string" } }, -"path": "projects/{project}/regions/{region}/networkEndpointGroups", +"path": "projects/{project}/regions/{region}/instantSnapshots", "request": { -"$ref": "NetworkEndpointGroup" +"$ref": "InstantSnapshot" }, "response": { "$ref": "Operation" @@ -30487,10 +30556,441 @@ ] }, "list": { -"description": "Retrieves the list of regional network endpoint groups available to the\nspecified project in the given region.", -"flatPath": "projects/{project}/regions/{region}/networkEndpointGroups", +"description": "Retrieves the list of InstantSnapshot resources contained within\nthe specified region.", +"flatPath": "projects/{project}/regions/{region}/instantSnapshots", "httpMethod": "GET", -"id": "compute.regionNetworkEndpointGroups.list", +"id": "compute.regionInstantSnapshots.list", +"parameterOrder": [ +"project", +"region" +], +"parameters": { +"filter": { +"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.", +"location": "query", +"type": "string" +}, +"maxResults": { +"default": "500", +"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`0` to `500`, inclusive. (Default: `500`)", +"format": "uint32", +"location": "query", +"minimum": "0", +"type": "integer" +}, +"orderBy": { +"description": "Sorts list results by a certain order. By default, results\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.", +"location": "query", +"type": "string" +}, +"pageToken": { +"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe next page of results.", +"location": "query", +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"region": { +"description": "The name of the region for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +}, +"returnPartialSuccess": { +"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.", +"location": "query", +"type": "boolean" +} +}, +"path": "projects/{project}/regions/{region}/instantSnapshots", +"response": { +"$ref": "InstantSnapshotList" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, +"setIamPolicy": { +"description": "Sets the access control policy on the specified resource.\nReplaces any existing policy.", +"flatPath": "projects/{project}/regions/{region}/instantSnapshots/{resource}/setIamPolicy", +"httpMethod": "POST", +"id": "compute.regionInstantSnapshots.setIamPolicy", +"parameterOrder": [ +"project", +"region", +"resource" +], +"parameters": { +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"region": { +"description": "The name of the region for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +}, +"resource": { +"description": "Name or id of the resource for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/regions/{region}/instantSnapshots/{resource}/setIamPolicy", +"request": { +"$ref": "RegionSetPolicyRequest" +}, +"response": { +"$ref": "Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, +"setLabels": { +"description": "Sets the labels on a instantSnapshot in the given region. To learn more\nabout labels, read the Labeling\nResources documentation.", +"flatPath": "projects/{project}/regions/{region}/instantSnapshots/{resource}/setLabels", +"httpMethod": "POST", +"id": "compute.regionInstantSnapshots.setLabels", +"parameterOrder": [ +"project", +"region", +"resource" +], +"parameters": { +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"region": { +"description": "The region for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"resource": { +"description": "Name or id of the resource for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/regions/{region}/instantSnapshots/{resource}/setLabels", +"request": { +"$ref": "RegionSetLabelsRequest" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, +"testIamPermissions": { +"description": "Returns permissions that a caller has on the specified resource.", +"flatPath": "projects/{project}/regions/{region}/instantSnapshots/{resource}/testIamPermissions", +"httpMethod": "POST", +"id": "compute.regionInstantSnapshots.testIamPermissions", +"parameterOrder": [ +"project", +"region", +"resource" +], +"parameters": { +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"region": { +"description": "The name of the region for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +}, +"resource": { +"description": "Name or id of the resource for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/regions/{region}/instantSnapshots/{resource}/testIamPermissions", +"request": { +"$ref": "TestPermissionsRequest" +}, +"response": { +"$ref": "TestPermissionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +} +} +}, +"regionNetworkEndpointGroups": { +"methods": { +"attachNetworkEndpoints": { +"description": "Attach a list of network endpoints to the specified network endpoint group.", +"flatPath": "projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}/attachNetworkEndpoints", +"httpMethod": "POST", +"id": "compute.regionNetworkEndpointGroups.attachNetworkEndpoints", +"parameterOrder": [ +"project", +"region", +"networkEndpointGroup" +], +"parameters": { +"networkEndpointGroup": { +"description": "The name of the network endpoint group where you are attaching network\nendpoints to. It should comply with RFC1035.", +"location": "path", +"required": true, +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"region": { +"description": "The name of the region where\nyou want to create the network endpoint group. It should comply with\nRFC1035.", +"location": "path", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +} +}, +"path": "projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}/attachNetworkEndpoints", +"request": { +"$ref": "RegionNetworkEndpointGroupsAttachEndpointsRequest" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, +"delete": { +"description": "Deletes the specified network endpoint group. Note that the NEG cannot be\ndeleted if it is configured as a backend of a backend service.", +"flatPath": "projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}", +"httpMethod": "DELETE", +"id": "compute.regionNetworkEndpointGroups.delete", +"parameterOrder": [ +"project", +"region", +"networkEndpointGroup" +], +"parameters": { +"networkEndpointGroup": { +"description": "The name of the network endpoint group to delete. It should comply with\nRFC1035.", +"location": "path", +"required": true, +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"region": { +"description": "The name of the region where\nthe network endpoint group is located. It should comply with RFC1035.", +"location": "path", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +} +}, +"path": "projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, +"detachNetworkEndpoints": { +"description": "Detach the network endpoint from the specified network endpoint group.", +"flatPath": "projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}/detachNetworkEndpoints", +"httpMethod": "POST", +"id": "compute.regionNetworkEndpointGroups.detachNetworkEndpoints", +"parameterOrder": [ +"project", +"region", +"networkEndpointGroup" +], +"parameters": { +"networkEndpointGroup": { +"description": "The name of the network endpoint group you are detaching network\nendpoints from. It should comply with RFC1035.", +"location": "path", +"required": true, +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"region": { +"description": "The name of the region where\nthe network endpoint group is located. It should comply with\nRFC1035.", +"location": "path", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).\nend_interface: MixerMutationRequestBuilder", +"location": "query", +"type": "string" +} +}, +"path": "projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}/detachNetworkEndpoints", +"request": { +"$ref": "RegionNetworkEndpointGroupsDetachEndpointsRequest" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, +"get": { +"description": "Returns the specified network endpoint group.", +"flatPath": "projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}", +"httpMethod": "GET", +"id": "compute.regionNetworkEndpointGroups.get", +"parameterOrder": [ +"project", +"region", +"networkEndpointGroup" +], +"parameters": { +"networkEndpointGroup": { +"description": "The name of the network endpoint group. It should comply with RFC1035.", +"location": "path", +"required": true, +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"region": { +"description": "The name of the region where\nthe network endpoint group is located. It should comply with RFC1035.", +"location": "path", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}", +"response": { +"$ref": "NetworkEndpointGroup" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, +"insert": { +"description": "Creates a network endpoint group in the specified project using the\nparameters that are included in the request.\n\nNote: Use the following APIs to manage network endpoint groups:\n \n - \n To manage NEGs with zonal scope (such as zonal NEGs, hybrid connectivity\n NEGs): zonal\n API\n - \n To manage NEGs with regional scope (such as regional internet NEGs,\n serverless NEGs, Private Service Connect NEGs): regional\n API\n - \n To manage NEGs with global scope (such as global internet NEGs):global\n API", +"flatPath": "projects/{project}/regions/{region}/networkEndpointGroups", +"httpMethod": "POST", +"id": "compute.regionNetworkEndpointGroups.insert", +"parameterOrder": [ +"project", +"region" +], +"parameters": { +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"region": { +"description": "The name of the region where\nyou want to create the network endpoint group. It should comply with\nRFC1035.", +"location": "path", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +} +}, +"path": "projects/{project}/regions/{region}/networkEndpointGroups", +"request": { +"$ref": "NetworkEndpointGroup" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, +"list": { +"description": "Retrieves the list of regional network endpoint groups available to the\nspecified project in the given region.", +"flatPath": "projects/{project}/regions/{region}/networkEndpointGroups", +"httpMethod": "GET", +"id": "compute.regionNetworkEndpointGroups.list", "parameterOrder": [ "project", "region" @@ -32499,6 +32999,532 @@ } } }, +"regionSnapshotSettings": { +"methods": { +"get": { +"description": "Get region snapshot settings.", +"flatPath": "projects/{project}/regions/{region}/snapshotSettings", +"httpMethod": "GET", +"id": "compute.regionSnapshotSettings.get", +"parameterOrder": [ +"project", +"region" +], +"parameters": { +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"region": { +"description": "Name of the region for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/regions/{region}/snapshotSettings", +"response": { +"$ref": "SnapshotSettings" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, +"patch": { +"description": "Patch region snapshot settings.", +"flatPath": "projects/{project}/regions/{region}/snapshotSettings", +"httpMethod": "PATCH", +"id": "compute.regionSnapshotSettings.patch", +"parameterOrder": [ +"project", +"region" +], +"parameters": { +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"region": { +"description": "Name of the region for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"updateMask": { +"description": "update_mask indicates fields to be updated as part of this request.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "projects/{project}/regions/{region}/snapshotSettings", +"request": { +"$ref": "SnapshotSettings" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +} +} +}, +"regionSnapshots": { +"methods": { +"delete": { +"description": "Deletes the specified Snapshot resource. Keep in mind that deleting\na single snapshot might not necessarily delete all the data on that\nsnapshot. If any data on the snapshot that is marked for deletion is\nneeded for subsequent snapshots, the data will be moved to the next\ncorresponding snapshot.\n\nFor more information, seeDeleting\nsnapshots.", +"flatPath": "projects/{project}/regions/{region}/snapshots/{snapshot}", +"httpMethod": "DELETE", +"id": "compute.regionSnapshots.delete", +"parameterOrder": [ +"project", +"region", +"snapshot" +], +"parameters": { +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"region": { +"description": "The name of the region for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"snapshot": { +"description": "Name of the snapshot resource to delete.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/regions/{region}/snapshots/{snapshot}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, +"get": { +"description": "Returns the specified Snapshot resource.", +"flatPath": "projects/{project}/regions/{region}/snapshots/{snapshot}", +"httpMethod": "GET", +"id": "compute.regionSnapshots.get", +"parameterOrder": [ +"project", +"region", +"snapshot" +], +"parameters": { +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"region": { +"description": "Name of the region for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +}, +"snapshot": { +"description": "Name of the Snapshot resource to return.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/regions/{region}/snapshots/{snapshot}", +"response": { +"$ref": "Snapshot" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, +"getIamPolicy": { +"description": "Gets the access control policy for a resource. May be empty if no such\npolicy or resource exists.", +"flatPath": "projects/{project}/regions/{region}/snapshots/{resource}/getIamPolicy", +"httpMethod": "GET", +"id": "compute.regionSnapshots.getIamPolicy", +"parameterOrder": [ +"project", +"region", +"resource" +], +"parameters": { +"optionsRequestedPolicyVersion": { +"description": "Requested IAM Policy version.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"region": { +"description": "The name of the region for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +}, +"resource": { +"description": "Name or id of the resource for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/regions/{region}/snapshots/{resource}/getIamPolicy", +"response": { +"$ref": "Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, +"insert": { +"description": "Creates a snapshot in the specified region using the data included\nin the request.", +"flatPath": "projects/{project}/regions/{region}/snapshots", +"httpMethod": "POST", +"id": "compute.regionSnapshots.insert", +"parameterOrder": [ +"project", +"region" +], +"parameters": { +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"region": { +"description": "Name of the region for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +} +}, +"path": "projects/{project}/regions/{region}/snapshots", +"request": { +"$ref": "Snapshot" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, +"list": { +"description": "Retrieves the list of Snapshot resources contained within\nthe specified region.", +"flatPath": "projects/{project}/regions/{region}/snapshots", +"httpMethod": "GET", +"id": "compute.regionSnapshots.list", +"parameterOrder": [ +"project", +"region" +], +"parameters": { +"filter": { +"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.", +"location": "query", +"type": "string" +}, +"maxResults": { +"default": "500", +"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`0` to `500`, inclusive. (Default: `500`)", +"format": "uint32", +"location": "query", +"minimum": "0", +"type": "integer" +}, +"orderBy": { +"description": "Sorts list results by a certain order. By default, results\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.", +"location": "query", +"type": "string" +}, +"pageToken": { +"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe next page of results.", +"location": "query", +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"region": { +"description": "Name of the region for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +}, +"returnPartialSuccess": { +"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.", +"location": "query", +"type": "boolean" +} +}, +"path": "projects/{project}/regions/{region}/snapshots", +"response": { +"$ref": "SnapshotList" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, +"setIamPolicy": { +"description": "Sets the access control policy on the specified resource.\nReplaces any existing policy.", +"flatPath": "projects/{project}/regions/{region}/snapshots/{resource}/setIamPolicy", +"httpMethod": "POST", +"id": "compute.regionSnapshots.setIamPolicy", +"parameterOrder": [ +"project", +"region", +"resource" +], +"parameters": { +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"region": { +"description": "The name of the region for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +}, +"resource": { +"description": "Name or id of the resource for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/regions/{region}/snapshots/{resource}/setIamPolicy", +"request": { +"$ref": "RegionSetPolicyRequest" +}, +"response": { +"$ref": "Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, +"setLabels": { +"description": "Sets the labels on a regional snapshot. To learn more about labels, read\nthe Labeling Resources\ndocumentation.", +"flatPath": "projects/{project}/regions/{region}/snapshots/{resource}/setLabels", +"httpMethod": "POST", +"id": "compute.regionSnapshots.setLabels", +"parameterOrder": [ +"project", +"region", +"resource" +], +"parameters": { +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"region": { +"description": "The region for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"resource": { +"description": "Name or id of the resource for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/regions/{region}/snapshots/{resource}/setLabels", +"request": { +"$ref": "RegionSetLabelsRequest" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, +"testIamPermissions": { +"description": "Returns permissions that a caller has on the specified resource.", +"flatPath": "projects/{project}/regions/{region}/snapshots/{resource}/testIamPermissions", +"httpMethod": "POST", +"id": "compute.regionSnapshots.testIamPermissions", +"parameterOrder": [ +"project", +"region", +"resource" +], +"parameters": { +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"region": { +"description": "The name of the region for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +}, +"resource": { +"description": "Name or id of the resource for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/regions/{region}/snapshots/{resource}/testIamPermissions", +"request": { +"$ref": "TestPermissionsRequest" +}, +"response": { +"$ref": "TestPermissionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, +"updateKmsKey": { +"description": "Rotates the customer-managed\nencryption key to the latest version for the specified snapshot.", +"flatPath": "projects/{project}/regions/{region}/snapshots/{snapshot}/updateKmsKey", +"httpMethod": "POST", +"id": "compute.regionSnapshots.updateKmsKey", +"parameterOrder": [ +"project", +"region", +"snapshot" +], +"parameters": { +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"region": { +"description": "Name of the region for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"snapshot": { +"description": "Name of the snapshot resource to update. Should conform to RFC1035.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/regions/{region}/snapshots/{snapshot}/updateKmsKey", +"request": { +"$ref": "RegionSnapshotUpdateKmsKeyRequest" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +} +} +}, "regionSslCertificates": { "methods": { "delete": { @@ -45980,7 +47006,7 @@ } } }, -"revision": "20260320", +"revision": "20260331", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -51639,6 +52665,14 @@ false "description": "A transient resource used in compute.disks.bulkInsert and\ncompute.regionDisks.bulkInsert. It is only used to process\nrequests and is not persisted.", "id": "BulkInsertDiskResource", "properties": { +"instantSnapshotGroupParameters": { +"$ref": "InstantSnapshotGroupParameters", +"description": "The parameters for the instant snapshot group." +}, +"snapshotGroupParameters": { +"$ref": "SnapshotGroupParameters", +"description": "The parameters for the snapshot group. The usage of snapshot group feature\nis restricted." +}, "sourceConsistencyGroupPolicy": { "description": "The URL of the DiskConsistencyGroupPolicy for the group of disks to clone.\nThis may be a full or partial URL, such as:\n \n \n - \n https://www.googleapis.com/compute/v1/projects/project/regions/region/resourcePolicies/resourcePolicy\n \n - \n projects/project/regions/region/resourcePolicies/resourcePolicy\n \n - \n regions/region/resourcePolicies/resourcePolicy", "type": "string" @@ -63307,13 +64341,6 @@ false "$ref": "InstanceParams", "description": "Input only. [Input Only] Additional params passed with the request, but not persisted\nas part of resource payload." }, -"partnerMetadata": { -"additionalProperties": { -"$ref": "StructuredEntries" -}, -"description": "Partner Metadata assigned to the instance. A map from a subdomain\n(namespace) to entries map.", -"type": "object" -}, "privateIpv6GoogleAccess": { "description": "The private IPv6 google access type for the VM.\nIf not specified, use INHERIT_FROM_SUBNETWORK as default.", "enum": [ @@ -67120,13 +68147,6 @@ false "$ref": "NetworkPerformanceConfig", "description": "Note that for MachineImage, this is not supported yet." }, -"partnerMetadata": { -"additionalProperties": { -"$ref": "StructuredEntries" -}, -"description": "Partner Metadata assigned to the instance properties. A map from a\nsubdomain (namespace) to entries map.", -"type": "object" -}, "privateIpv6GoogleAccess": { "description": "The private IPv6 google access type for VMs.\nIf not specified, use INHERIT_FROM_SUBNETWORK as default.\nNote that for MachineImage, this is not supported yet.", "enum": [ @@ -68352,6 +69372,16 @@ false "readOnly": true, "type": "string" }, +"sourceInstantSnapshotGroup": { +"description": "Output only. [Output Only] URL of the source instant snapshot this instant snapshot is\npart of. Note that the source instant snapshot group must be in the same\nzone/region as the instant snapshot to be created. This can be a full or\nvalid partial URL.", +"readOnly": true, +"type": "string" +}, +"sourceInstantSnapshotGroupId": { +"description": "Output only. [Output Only] The ID value of the source instant snapshot group this\nInstantSnapshot is part of. This value may be used to determine whether the\nInstantSnapshot was created as part of an InstantSnapshotGroup creation.", +"readOnly": true, +"type": "string" +}, "status": { "description": "Output only. [Output Only] The status of the instantSnapshot. This can beCREATING, DELETING, FAILED, orREADY.", "enum": [ @@ -68544,6 +69574,128 @@ false }, "type": "object" }, +"InstantSnapshotGroup": { +"description": "Represents an InstantSnapshotGroup resource.\n\nAn instant snapshot group is a set of instant snapshots that represents a\npoint in time state of a consistency group.", +"id": "InstantSnapshotGroup", +"properties": { +"creationTimestamp": { +"description": "Output only. [Output Only] Creation timestamp inRFC3339\ntext format.", +"readOnly": true, +"type": "string" +}, +"description": { +"description": "Optional. An optional description of this resource. Provide this property when you\ncreate the resource.", +"type": "string" +}, +"id": { +"description": "Output only. [Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.", +"format": "uint64", +"readOnly": true, +"type": "string" +}, +"kind": { +"default": "compute#instantSnapshotGroup", +"description": "Output only. [Output Only] Type of the resource. Alwayscompute#instantSnapshotGroup for InstantSnapshotGroup\nresources.", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Identifier. Name of the resource; provided by the client when the resource is created.\nThe name must be 1-63 characters long, and comply withRFC1035.\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first\ncharacter must be a lowercase letter, and all following characters must be\na dash, lowercase letter, or digit, except the last character, which cannot\nbe a dash.", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"type": "string" +}, +"region": { +"description": "Output only. [Output Only] URL of the region where the instant snapshot group resides.\nYou must specify this field as part of the HTTP request URL. It is\nnot settable as a field in the request body.", +"readOnly": true, +"type": "string" +}, +"resourceStatus": { +"$ref": "InstantSnapshotGroupResourceStatus", +"readOnly": true +}, +"selfLink": { +"description": "Output only. [Output Only] Server-defined URL for the resource.", +"readOnly": true, +"type": "string" +}, +"selfLinkWithId": { +"description": "Output only. [Output Only] Server-defined URL for this resource's resource id.", +"readOnly": true, +"type": "string" +}, +"sourceConsistencyGroup": { +"type": "string" +}, +"status": { +"description": "Output only. [Output Only]", +"enum": [ +"CREATING", +"DELETING", +"FAILED", +"INVALID", +"READY", +"UNKNOWN" +], +"enumDescriptions": [ +"", +"", +"", +"", +"", +"" +], +"readOnly": true, +"type": "string" +}, +"zone": { +"description": "Output only. [Output Only] URL of the zone where the instant snapshot group resides.\nYou must specify this field as part of the HTTP request URL. It is\nnot settable as a field in the request body.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"InstantSnapshotGroupParameters": { +"id": "InstantSnapshotGroupParameters", +"properties": { +"sourceInstantSnapshotGroup": { +"description": "The source instant snapshot group used to create disks. You can provide\nthis as a partial or full URL to the resource. For example, the following\nare valid values:\n \n \n - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instantSnapshotGroups/instantSnapshotGroup\n - projects/project/zones/zone/instantSnapshotGroups/instantSnapshotGroup\n - zones/zone/instantSnapshotGroups/instantSnapshotGroup", +"type": "string" +} +}, +"type": "object" +}, +"InstantSnapshotGroupResourceStatus": { +"id": "InstantSnapshotGroupResourceStatus", +"properties": { +"consistencyMembershipResolutionTime": { +"description": "Output only. [Output Only]", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"sourceInfo": { +"$ref": "InstantSnapshotGroupSourceInfo", +"description": "Output only. [Output Only]", +"readOnly": true +} +}, +"type": "object" +}, +"InstantSnapshotGroupSourceInfo": { +"id": "InstantSnapshotGroupSourceInfo", +"properties": { +"consistencyGroup": { +"readOnly": true, +"type": "string" +}, +"consistencyGroupId": { +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "InstantSnapshotList": { "description": "Contains a list of InstantSnapshot resources.", "id": "InstantSnapshotList", @@ -73138,6 +74290,174 @@ false }, "type": "object" }, +"ListInstantSnapshotGroups": { +"description": "Contains a list of InstantSnapshotGroup resources.", +"id": "ListInstantSnapshotGroups", +"properties": { +"etag": { +"type": "string" +}, +"id": { +"description": "[Output Only] Unique identifier for the resource; defined by the server.", +"type": "string" +}, +"items": { +"description": "A list of InstantSnapshotGroup resources.", +"items": { +"$ref": "InstantSnapshotGroup" +}, +"type": "array" +}, +"kind": { +"default": "compute#instantSnapshotGroupsList", +"description": "Output only. Type of resource.", +"readOnly": true, +"type": "string" +}, +"nextPageToken": { +"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.", +"type": "string" +}, +"selfLink": { +"description": "Output only. [Output Only] Server-defined URL for this resource.", +"readOnly": true, +"type": "string" +}, +"unreachables": { +"description": "Output only. [Output Only] Unreachable resources.\nend_interface: MixerListResponseWithEtagBuilder", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"warning": { +"description": "[Output Only] Informational warning message.", +"properties": { +"code": { +"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare no results in the response.", +"enum": [ +"CLEANUP_FAILED", +"DEPRECATED_RESOURCE_USED", +"DEPRECATED_TYPE_USED", +"DISK_SIZE_LARGER_THAN_IMAGE_SIZE", +"EXPERIMENTAL_TYPE_USED", +"EXTERNAL_API_WARNING", +"FIELD_VALUE_OVERRIDEN", +"INJECTED_KERNELS_DEPRECATED", +"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", +"LARGE_DEPLOYMENT_WARNING", +"LIST_OVERHEAD_QUOTA_EXCEED", +"MISSING_TYPE_DEPENDENCY", +"NEXT_HOP_ADDRESS_NOT_ASSIGNED", +"NEXT_HOP_CANNOT_IP_FORWARD", +"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", +"NEXT_HOP_INSTANCE_NOT_FOUND", +"NEXT_HOP_INSTANCE_NOT_ON_NETWORK", +"NEXT_HOP_NOT_RUNNING", +"NOT_CRITICAL_ERROR", +"NO_RESULTS_ON_PAGE", +"PARTIAL_SUCCESS", +"QUOTA_INFO_UNAVAILABLE", +"REQUIRED_TOS_AGREEMENT", +"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", +"RESOURCE_NOT_DELETED", +"SCHEMA_VALIDATION_IGNORED", +"SINGLE_INSTANCE_PROPERTY_TEMPLATE", +"UNDECLARED_PROPERTIES", +"UNREACHABLE" +], +"enumDeprecated": [ +false, +false, +false, +false, +false, +false, +true, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false +], +"enumDescriptions": [ +"Warning about failed cleanup of transient changes made by a failed\noperation.", +"A link to a deprecated resource was created.", +"When deploying and at least one of the resources has a type marked as\ndeprecated", +"The user created a boot disk that is larger than image size.", +"When deploying and at least one of the resources has a type marked as\nexperimental", +"Warning that is present in an external api call", +"Warning that value of a field has been overridden.\nDeprecated unused field.", +"The operation involved use of an injected kernel, which is deprecated.", +"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.", +"When deploying a deployment with a exceedingly large number of resources", +"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.", +"A resource depends on a missing type", +"The route's nextHopIp address is not assigned to an instance on the\nnetwork.", +"The route's next hop instance cannot ip forward.", +"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.", +"The route's nextHopInstance URL refers to an instance that does not exist.", +"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.", +"The route's next hop instance does not have a status of RUNNING.", +"Error which is not critical. We decided to continue the process despite\nthe mentioned error.", +"No results are present on a particular list page.", +"Success is reported, but some results may be missing due to errors", +"Quota information is not available to client requests (e.g:\nregions.list).", +"The user attempted to use a resource that requires a TOS they have not\naccepted.", +"Warning that a resource is in use.", +"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.", +"When a resource schema validation is ignored.", +"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.", +"When undeclared properties in the schema are present", +"A given scope cannot be reached." +], +"type": "string" +}, +"data": { +"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n {\n \"key\": \"scope\",\n \"value\": \"zones/us-east1-d\"\n }", +"items": { +"properties": { +"key": { +"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts to perform IP forwarding but is not enabled for IP forwarding).", +"type": "string" +}, +"value": { +"description": "[Output Only] A warning data value corresponding to the key.", +"type": "string" +} +}, +"type": "object" +}, +"type": "array" +}, +"message": { +"description": "[Output Only] A human-readable description of the warning code.", +"type": "string" +} +}, +"type": "object" +} +}, +"type": "object" +}, "LocalDisk": { "id": "LocalDisk", "properties": { @@ -82224,229 +83544,210 @@ false }, "type": "object" }, -"PacketMirroringMirroredResourceInfo": { -"id": "PacketMirroringMirroredResourceInfo", -"properties": { -"instances": { -"description": "A set of virtual machine instances that are being mirrored.\nThey must live in zones contained in the same region as this\npacketMirroring.\n\nNote that this config will apply only to those network interfaces of the\nInstances that belong to the network specified in this packetMirroring.\n\nYou may specify a maximum of 50 Instances.", -"items": { -"$ref": "PacketMirroringMirroredResourceInfoInstanceInfo" -}, -"type": "array" -}, -"subnetworks": { -"description": "A set of subnetworks for which traffic from/to all VM instances will be\nmirrored. They must live in the same region as this packetMirroring.\n\nYou may specify a maximum of 5 subnetworks.", -"items": { -"$ref": "PacketMirroringMirroredResourceInfoSubnetInfo" -}, -"type": "array" -}, -"tags": { -"description": "A set of mirrored tags. Traffic from/to all VM instances that have one or\nmore of these tags will be mirrored.", -"items": { -"type": "string" -}, -"type": "array" -} -}, -"type": "object" -}, -"PacketMirroringMirroredResourceInfoInstanceInfo": { -"id": "PacketMirroringMirroredResourceInfoInstanceInfo", -"properties": { -"canonicalUrl": { -"description": "Output only. [Output Only] Unique identifier for the instance; defined by the\nserver.", -"readOnly": true, -"type": "string" -}, -"url": { -"description": "Resource URL to the virtual machine instance which is being mirrored.", -"type": "string" -} -}, -"type": "object" -}, -"PacketMirroringMirroredResourceInfoSubnetInfo": { -"id": "PacketMirroringMirroredResourceInfoSubnetInfo", -"properties": { -"canonicalUrl": { -"description": "Output only. [Output Only] Unique identifier for the subnetwork; defined by the\nserver.", -"readOnly": true, -"type": "string" -}, -"url": { -"description": "Resource URL to the subnetwork for which\ntraffic from/to all VM instances will be mirrored.", -"type": "string" -} -}, -"type": "object" -}, -"PacketMirroringNetworkInfo": { -"id": "PacketMirroringNetworkInfo", -"properties": { -"canonicalUrl": { -"description": "Output only. [Output Only] Unique identifier for the network; defined by the server.", -"readOnly": true, -"type": "string" -}, -"url": { -"description": "URL of the network resource.", -"type": "string" -} -}, -"type": "object" -}, -"PacketMirroringsScopedList": { -"id": "PacketMirroringsScopedList", -"properties": { -"packetMirrorings": { -"description": "A list of packetMirrorings contained in this scope.", -"items": { -"$ref": "PacketMirroring" -}, -"type": "array" -}, -"warning": { -"description": "Informational warning which replaces the list of packetMirrorings when the\nlist is empty.", -"properties": { -"code": { -"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare no results in the response.", -"enum": [ -"CLEANUP_FAILED", -"DEPRECATED_RESOURCE_USED", -"DEPRECATED_TYPE_USED", -"DISK_SIZE_LARGER_THAN_IMAGE_SIZE", -"EXPERIMENTAL_TYPE_USED", -"EXTERNAL_API_WARNING", -"FIELD_VALUE_OVERRIDEN", -"INJECTED_KERNELS_DEPRECATED", -"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", -"LARGE_DEPLOYMENT_WARNING", -"LIST_OVERHEAD_QUOTA_EXCEED", -"MISSING_TYPE_DEPENDENCY", -"NEXT_HOP_ADDRESS_NOT_ASSIGNED", -"NEXT_HOP_CANNOT_IP_FORWARD", -"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", -"NEXT_HOP_INSTANCE_NOT_FOUND", -"NEXT_HOP_INSTANCE_NOT_ON_NETWORK", -"NEXT_HOP_NOT_RUNNING", -"NOT_CRITICAL_ERROR", -"NO_RESULTS_ON_PAGE", -"PARTIAL_SUCCESS", -"QUOTA_INFO_UNAVAILABLE", -"REQUIRED_TOS_AGREEMENT", -"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", -"RESOURCE_NOT_DELETED", -"SCHEMA_VALIDATION_IGNORED", -"SINGLE_INSTANCE_PROPERTY_TEMPLATE", -"UNDECLARED_PROPERTIES", -"UNREACHABLE" -], -"enumDeprecated": [ -false, -false, -false, -false, -false, -false, -true, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false -], -"enumDescriptions": [ -"Warning about failed cleanup of transient changes made by a failed\noperation.", -"A link to a deprecated resource was created.", -"When deploying and at least one of the resources has a type marked as\ndeprecated", -"The user created a boot disk that is larger than image size.", -"When deploying and at least one of the resources has a type marked as\nexperimental", -"Warning that is present in an external api call", -"Warning that value of a field has been overridden.\nDeprecated unused field.", -"The operation involved use of an injected kernel, which is deprecated.", -"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.", -"When deploying a deployment with a exceedingly large number of resources", -"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.", -"A resource depends on a missing type", -"The route's nextHopIp address is not assigned to an instance on the\nnetwork.", -"The route's next hop instance cannot ip forward.", -"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.", -"The route's nextHopInstance URL refers to an instance that does not exist.", -"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.", -"The route's next hop instance does not have a status of RUNNING.", -"Error which is not critical. We decided to continue the process despite\nthe mentioned error.", -"No results are present on a particular list page.", -"Success is reported, but some results may be missing due to errors", -"Quota information is not available to client requests (e.g:\nregions.list).", -"The user attempted to use a resource that requires a TOS they have not\naccepted.", -"Warning that a resource is in use.", -"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.", -"When a resource schema validation is ignored.", -"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.", -"When undeclared properties in the schema are present", -"A given scope cannot be reached." -], -"type": "string" -}, -"data": { -"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n {\n \"key\": \"scope\",\n \"value\": \"zones/us-east1-d\"\n }", -"items": { -"properties": { -"key": { -"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts to perform IP forwarding but is not enabled for IP forwarding).", -"type": "string" -}, -"value": { -"description": "[Output Only] A warning data value corresponding to the key.", -"type": "string" -} -}, -"type": "object" -}, -"type": "array" -}, -"message": { -"description": "[Output Only] A human-readable description of the warning code.", -"type": "string" -} -}, -"type": "object" -} -}, -"type": "object" -}, -"PartnerMetadata": { -"description": "Model definition of partner_metadata field.\nTo be used in dedicated Partner Metadata methods and to be inlined in\nthe Instance and InstanceTemplate resources.", -"id": "PartnerMetadata", +"PacketMirroringMirroredResourceInfo": { +"id": "PacketMirroringMirroredResourceInfo", "properties": { -"fingerprint": { -"description": "Instance-level hash to be used for optimistic\nlocking.", -"format": "byte", +"instances": { +"description": "A set of virtual machine instances that are being mirrored.\nThey must live in zones contained in the same region as this\npacketMirroring.\n\nNote that this config will apply only to those network interfaces of the\nInstances that belong to the network specified in this packetMirroring.\n\nYou may specify a maximum of 50 Instances.", +"items": { +"$ref": "PacketMirroringMirroredResourceInfoInstanceInfo" +}, +"type": "array" +}, +"subnetworks": { +"description": "A set of subnetworks for which traffic from/to all VM instances will be\nmirrored. They must live in the same region as this packetMirroring.\n\nYou may specify a maximum of 5 subnetworks.", +"items": { +"$ref": "PacketMirroringMirroredResourceInfoSubnetInfo" +}, +"type": "array" +}, +"tags": { +"description": "A set of mirrored tags. Traffic from/to all VM instances that have one or\nmore of these tags will be mirrored.", +"items": { "type": "string" }, -"partnerMetadata": { -"additionalProperties": { -"$ref": "StructuredEntries" +"type": "array" +} +}, +"type": "object" +}, +"PacketMirroringMirroredResourceInfoInstanceInfo": { +"id": "PacketMirroringMirroredResourceInfoInstanceInfo", +"properties": { +"canonicalUrl": { +"description": "Output only. [Output Only] Unique identifier for the instance; defined by the\nserver.", +"readOnly": true, +"type": "string" +}, +"url": { +"description": "Resource URL to the virtual machine instance which is being mirrored.", +"type": "string" +} +}, +"type": "object" +}, +"PacketMirroringMirroredResourceInfoSubnetInfo": { +"id": "PacketMirroringMirroredResourceInfoSubnetInfo", +"properties": { +"canonicalUrl": { +"description": "Output only. [Output Only] Unique identifier for the subnetwork; defined by the\nserver.", +"readOnly": true, +"type": "string" +}, +"url": { +"description": "Resource URL to the subnetwork for which\ntraffic from/to all VM instances will be mirrored.", +"type": "string" +} +}, +"type": "object" +}, +"PacketMirroringNetworkInfo": { +"id": "PacketMirroringNetworkInfo", +"properties": { +"canonicalUrl": { +"description": "Output only. [Output Only] Unique identifier for the network; defined by the server.", +"readOnly": true, +"type": "string" +}, +"url": { +"description": "URL of the network resource.", +"type": "string" +} +}, +"type": "object" +}, +"PacketMirroringsScopedList": { +"id": "PacketMirroringsScopedList", +"properties": { +"packetMirrorings": { +"description": "A list of packetMirrorings contained in this scope.", +"items": { +"$ref": "PacketMirroring" +}, +"type": "array" +}, +"warning": { +"description": "Informational warning which replaces the list of packetMirrorings when the\nlist is empty.", +"properties": { +"code": { +"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare no results in the response.", +"enum": [ +"CLEANUP_FAILED", +"DEPRECATED_RESOURCE_USED", +"DEPRECATED_TYPE_USED", +"DISK_SIZE_LARGER_THAN_IMAGE_SIZE", +"EXPERIMENTAL_TYPE_USED", +"EXTERNAL_API_WARNING", +"FIELD_VALUE_OVERRIDEN", +"INJECTED_KERNELS_DEPRECATED", +"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", +"LARGE_DEPLOYMENT_WARNING", +"LIST_OVERHEAD_QUOTA_EXCEED", +"MISSING_TYPE_DEPENDENCY", +"NEXT_HOP_ADDRESS_NOT_ASSIGNED", +"NEXT_HOP_CANNOT_IP_FORWARD", +"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", +"NEXT_HOP_INSTANCE_NOT_FOUND", +"NEXT_HOP_INSTANCE_NOT_ON_NETWORK", +"NEXT_HOP_NOT_RUNNING", +"NOT_CRITICAL_ERROR", +"NO_RESULTS_ON_PAGE", +"PARTIAL_SUCCESS", +"QUOTA_INFO_UNAVAILABLE", +"REQUIRED_TOS_AGREEMENT", +"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", +"RESOURCE_NOT_DELETED", +"SCHEMA_VALIDATION_IGNORED", +"SINGLE_INSTANCE_PROPERTY_TEMPLATE", +"UNDECLARED_PROPERTIES", +"UNREACHABLE" +], +"enumDeprecated": [ +false, +false, +false, +false, +false, +false, +true, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false +], +"enumDescriptions": [ +"Warning about failed cleanup of transient changes made by a failed\noperation.", +"A link to a deprecated resource was created.", +"When deploying and at least one of the resources has a type marked as\ndeprecated", +"The user created a boot disk that is larger than image size.", +"When deploying and at least one of the resources has a type marked as\nexperimental", +"Warning that is present in an external api call", +"Warning that value of a field has been overridden.\nDeprecated unused field.", +"The operation involved use of an injected kernel, which is deprecated.", +"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.", +"When deploying a deployment with a exceedingly large number of resources", +"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.", +"A resource depends on a missing type", +"The route's nextHopIp address is not assigned to an instance on the\nnetwork.", +"The route's next hop instance cannot ip forward.", +"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.", +"The route's nextHopInstance URL refers to an instance that does not exist.", +"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.", +"The route's next hop instance does not have a status of RUNNING.", +"Error which is not critical. We decided to continue the process despite\nthe mentioned error.", +"No results are present on a particular list page.", +"Success is reported, but some results may be missing due to errors", +"Quota information is not available to client requests (e.g:\nregions.list).", +"The user attempted to use a resource that requires a TOS they have not\naccepted.", +"Warning that a resource is in use.", +"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.", +"When a resource schema validation is ignored.", +"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.", +"When undeclared properties in the schema are present", +"A given scope cannot be reached." +], +"type": "string" +}, +"data": { +"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n {\n \"key\": \"scope\",\n \"value\": \"zones/us-east1-d\"\n }", +"items": { +"properties": { +"key": { +"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts to perform IP forwarding but is not enabled for IP forwarding).", +"type": "string" +}, +"value": { +"description": "[Output Only] A warning data value corresponding to the key.", +"type": "string" +} +}, +"type": "object" +}, +"type": "array" +}, +"message": { +"description": "[Output Only] A human-readable description of the warning code.", +"type": "string" +} }, -"description": "Partner Metadata assigned to the instance. A map from a subdomain to\nentries map. Subdomain name must be compliant withRFC1035\ndefinition. The total size of all keys and values must be less than 2MB.\nSubdomain 'metadata.compute.googleapis.com' is reserverd for instance's\nmetadata.", "type": "object" } }, @@ -86657,6 +87958,16 @@ false }, "type": "object" }, +"RegionSnapshotUpdateKmsKeyRequest": { +"id": "RegionSnapshotUpdateKmsKeyRequest", +"properties": { +"kmsKeyName": { +"description": "Optional. The new KMS key to replace the current one on the snapshot. If empty, the\nsnapshot will be re-encrypted using the primary version of the snapshot's\ncurrent KMS key.\n\nThe KMS key can be provided in the following formats:\n \n \n - projects/project_id/locations/region/keyRings/region/cryptoKeys/key", +"type": "string" +} +}, +"type": "object" +}, "RegionTargetHttpsProxiesSetSslCertificatesRequest": { "id": "RegionTargetHttpsProxiesSetSslCertificatesRequest", "properties": { @@ -94941,6 +96252,11 @@ false "$ref": "SnapshotParams", "description": "Input only. [Input Only] Additional params passed with the request, but not persisted\nas part of resource payload." }, +"region": { +"description": "Output only. [Output Only] URL of the region where the snapshot resides. Only applicable\nfor regional snapshots.", +"readOnly": true, +"type": "string" +}, "satisfiesPzi": { "description": "Output only. Reserved for future use.", "readOnly": true, @@ -94960,6 +96276,16 @@ false "$ref": "CustomerEncryptionKey", "description": "Encrypts the snapshot using acustomer-supplied\nencryption key.\n\nAfter you encrypt a snapshot using a customer-supplied key, you must\nprovide the same key if you use the snapshot later. For example, you must\nprovide the encryption key when you create a disk from the encrypted\nsnapshot in a future request.\n\nCustomer-supplied encryption keys do not protect access to metadata\nof the snapshot.\n\nIf you do not provide an encryption key when creating the snapshot, then\nthe snapshot will be encrypted using an automatically generated key and you\ndo not need to provide a key to use the snapshot later." }, +"snapshotGroupId": { +"description": "Output only. [Output Only] The unique ID of the snapshot group that this snapshot\nbelongs to. The usage of snapshot group feature is restricted.", +"readOnly": true, +"type": "string" +}, +"snapshotGroupName": { +"description": "Output only. [Output only] The snapshot group that this snapshot belongs to. The usage\nof snapshot group feature is restricted.", +"readOnly": true, +"type": "string" +}, "snapshotType": { "description": "Indicates the type of the snapshot.", "enum": [ @@ -95060,6 +96386,27 @@ false }, "type": "object" }, +"SnapshotGroupParameters": { +"id": "SnapshotGroupParameters", +"properties": { +"replicaZones": { +"description": "URLs of the zones where disks should be replicated to. Only applicable\nfor regional resources.", +"items": { +"type": "string" +}, +"type": "array" +}, +"sourceSnapshotGroup": { +"description": "The source snapshot group used to create disks. You can provide this as a\npartial or full URL to the resource. For example, the following are valid\nvalues:\n \n \n - https://www.googleapis.com/compute/v1/projects/project/global/snapshotGroups/snapshotGroup \n - projects/project/global/snapshotGroups/snapshotGroup\n - global/snapshotGroups/snapshotGroup", +"type": "string" +}, +"type": { +"description": "URL of the disk type resource describing which disk type to use to create\ndisks. Provide this when creating the disk. For example:projects/project/zones/zone/diskTypes/pd-ssd. See Persistent disk\ntypes.", +"type": "string" +} +}, +"type": "object" +}, "SnapshotList": { "description": "Contains a list of Snapshot resources.", "id": "SnapshotList", @@ -95234,6 +96581,10 @@ false "SnapshotSettings": { "id": "SnapshotSettings", "properties": { +"accessLocation": { +"$ref": "SnapshotSettingsAccessLocation", +"description": "(Regional snapshots use only)Policy of which location is allowed to access\nsnapshot." +}, "storageLocation": { "$ref": "SnapshotSettingsStorageLocationSettings", "description": "Policy of which storage location is going to be resolved, and additional\ndata that particularizes how the policy is going to be carried out." @@ -95241,6 +96592,44 @@ false }, "type": "object" }, +"SnapshotSettingsAccessLocation": { +"id": "SnapshotSettingsAccessLocation", +"properties": { +"locations": { +"additionalProperties": { +"$ref": "SnapshotSettingsAccessLocationAccessLocationPreference" +}, +"description": "List of regions that can restore a regional\n snapshot from the current region", +"type": "object" +}, +"policy": { +"description": "Policy of which location is allowed to access snapshot.", +"enum": [ +"ALL_REGIONS", +"POLICY_UNSPECIFIED", +"SPECIFIC_REGIONS" +], +"enumDescriptions": [ +"Any regions will be able to access the source location.", +"", +"Only allowlisted regions will be able to restore region scoped\nsnapshots" +], +"type": "string" +} +}, +"type": "object" +}, +"SnapshotSettingsAccessLocationAccessLocationPreference": { +"description": "A structure for specifying an allowed target region.", +"id": "SnapshotSettingsAccessLocationAccessLocationPreference", +"properties": { +"region": { +"description": "Accessible region name", +"type": "string" +} +}, +"type": "object" +}, "SnapshotSettingsStorageLocationSettings": { "id": "SnapshotSettingsStorageLocationSettings", "properties": { @@ -98391,20 +99780,6 @@ false }, "type": "object" }, -"StructuredEntries": { -"id": "StructuredEntries", -"properties": { -"entries": { -"additionalProperties": { -"format": "google.protobuf.Value", -"type": "any" -}, -"description": "Map of a partner metadata that belong to the same subdomain.\nIt accepts any value including google.protobuf.Struct.", -"type": "object" -} -}, -"type": "object" -}, "Subnetwork": { "description": "Represents a Subnetwork resource.\n\nA subnetwork (also known as a subnet) is a logical partition of a Virtual\nPrivate Cloud network with one primary IP range and zero or more secondary\nIP ranges. For more information, read\nVirtual Private Cloud (VPC) Network.", "id": "Subnetwork", @@ -107361,6 +108736,7 @@ false } }, "servicePath": "compute/v1/", +"serviceVersion": "v1", "title": "Compute Engine API", "version": "v1" } \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json b/googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json index f69f745be2..f887566db9 100644 --- a/googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json +++ b/googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json @@ -6101,7 +6101,7 @@ } } }, -"revision": "20260327", +"revision": "20260401", "rootUrl": "https://contactcenterinsights.googleapis.com/", "schemas": { "GoogleCloudContactcenterinsightsV1Analysis": { @@ -7285,6 +7285,10 @@ true "description": "Configurable dashboard's widget that displays data as a chart.", "id": "GoogleCloudContactcenterinsightsV1Chart", "properties": { +"action": { +"$ref": "GoogleCloudContactcenterinsightsV1ChartAction", +"description": "Optional action to be taken when the chart is clicked." +}, "chartType": { "description": "Output only. Chart type.", "enum": [ @@ -7378,6 +7382,17 @@ true }, "type": "object" }, +"GoogleCloudContactcenterinsightsV1ChartAction": { +"description": "The action to be taken when the chart is clicked.", +"id": "GoogleCloudContactcenterinsightsV1ChartAction", +"properties": { +"redirectAction": { +"$ref": "GoogleCloudContactcenterinsightsV1RedirectAction", +"description": "Redirect action." +} +}, +"type": "object" +}, "GoogleCloudContactcenterinsightsV1ChartDataSource": { "description": "The request data for visualizing the dataset in the chart.", "id": "GoogleCloudContactcenterinsightsV1ChartDataSource", @@ -7912,6 +7927,10 @@ true "description": "A user-provided string indicating the outcome of the agent's segment of the call.", "type": "string" }, +"entrySubagentDisplayName": { +"description": "The entry subagent's display name.", +"type": "string" +}, "location": { "description": "The agent's location.", "type": "string" @@ -12123,6 +12142,17 @@ true }, "type": "object" }, +"GoogleCloudContactcenterinsightsV1RedirectAction": { +"description": "The redirect action to be taken when the chart is clicked.", +"id": "GoogleCloudContactcenterinsightsV1RedirectAction", +"properties": { +"relativePath": { +"description": "The relative path to redirect to.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudContactcenterinsightsV1RegexMatchConfig": { "description": "Regex match configuration.", "id": "GoogleCloudContactcenterinsightsV1RegexMatchConfig", @@ -13982,6 +14012,10 @@ true "description": "A user-provided string indicating the outcome of the agent's segment of the call.", "type": "string" }, +"entrySubagentDisplayName": { +"description": "The entry subagent's display name.", +"type": "string" +}, "location": { "description": "The agent's location.", "type": "string" @@ -18528,6 +18562,10 @@ true "description": "A user-provided string indicating the outcome of the agent's segment of the call.", "type": "string" }, +"entrySubagentDisplayName": { +"description": "The entry subagent's display name.", +"type": "string" +}, "location": { "description": "The agent's location.", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/container.v1.json b/googleapiclient/discovery_cache/documents/container.v1.json index 4c675a97d2..a10e299181 100644 --- a/googleapiclient/discovery_cache/documents/container.v1.json +++ b/googleapiclient/discovery_cache/documents/container.v1.json @@ -2660,7 +2660,7 @@ } } }, -"revision": "20260323", +"revision": "20260324", "rootUrl": "https://container.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -7163,6 +7163,10 @@ false "description": "Parameters for node pool-level network config.", "id": "NodeNetworkConfig", "properties": { +"acceleratorNetworkProfile": { +"description": "Immutable. The accelerator network profile for the node pool. For now the only valid value is \"auto\". If specified, the network configuration of the nodes in this node pool will be managed by this profile for the supported machine types, zone, etc.", +"type": "string" +}, "additionalNodeNetworkConfigs": { "description": "We specify the additional node networks for this node pool using this list. Each node network corresponds to an additional interface", "items": { diff --git a/googleapiclient/discovery_cache/documents/containeranalysis.v1.json b/googleapiclient/discovery_cache/documents/containeranalysis.v1.json index 192d36d8e8..c6cbc3db33 100644 --- a/googleapiclient/discovery_cache/documents/containeranalysis.v1.json +++ b/googleapiclient/discovery_cache/documents/containeranalysis.v1.json @@ -1715,7 +1715,7 @@ } } }, -"revision": "20260313", +"revision": "20260320", "rootUrl": "https://containeranalysis.googleapis.com/", "schemas": { "AliasContext": { @@ -5657,6 +5657,11 @@ false "description": "An instance of an analysis type that has been found on a resource.", "id": "Occurrence", "properties": { +"advisoryPublishTime": { +"description": "The time this advisory was published by the source.", +"format": "google-datetime", +"type": "string" +}, "attestation": { "$ref": "AttestationOccurrence", "description": "Describes an attestation of an artifact." diff --git a/googleapiclient/discovery_cache/documents/dataform.v1.json b/googleapiclient/discovery_cache/documents/dataform.v1.json index 075e2d22f1..982662ae30 100644 --- a/googleapiclient/discovery_cache/documents/dataform.v1.json +++ b/googleapiclient/discovery_cache/documents/dataform.v1.json @@ -17,6 +17,213 @@ "description": "Service to develop, version control, and operationalize SQL pipelines in BigQuery.", "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/dataform/docs", +"endpoints": [ +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataform.africa-south1.rep.googleapis.com/", +"location": "africa-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataform.asia-east1.rep.googleapis.com/", +"location": "asia-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataform.asia-east2.rep.googleapis.com/", +"location": "asia-east2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataform.asia-northeast1.rep.googleapis.com/", +"location": "asia-northeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataform.asia-northeast2.rep.googleapis.com/", +"location": "asia-northeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataform.asia-northeast3.rep.googleapis.com/", +"location": "asia-northeast3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataform.asia-south1.rep.googleapis.com/", +"location": "asia-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataform.asia-south2.rep.googleapis.com/", +"location": "asia-south2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataform.asia-southeast1.rep.googleapis.com/", +"location": "asia-southeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataform.asia-southeast2.rep.googleapis.com/", +"location": "asia-southeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataform.australia-southeast1.rep.googleapis.com/", +"location": "australia-southeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataform.australia-southeast2.rep.googleapis.com/", +"location": "australia-southeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataform.europe-central2.rep.googleapis.com/", +"location": "europe-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataform.europe-north1.rep.googleapis.com/", +"location": "europe-north1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataform.europe-north2.rep.googleapis.com/", +"location": "europe-north2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataform.europe-southwest1.rep.googleapis.com/", +"location": "europe-southwest1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataform.europe-west1.rep.googleapis.com/", +"location": "europe-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataform.europe-west10.rep.googleapis.com/", +"location": "europe-west10" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataform.europe-west12.rep.googleapis.com/", +"location": "europe-west12" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataform.europe-west2.rep.googleapis.com/", +"location": "europe-west2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataform.europe-west3.rep.googleapis.com/", +"location": "europe-west3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataform.europe-west6.rep.googleapis.com/", +"location": "europe-west6" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataform.europe-west8.rep.googleapis.com/", +"location": "europe-west8" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataform.europe-west9.rep.googleapis.com/", +"location": "europe-west9" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataform.me-central1.rep.googleapis.com/", +"location": "me-central1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataform.me-central2.rep.googleapis.com/", +"location": "me-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataform.me-west1.rep.googleapis.com/", +"location": "me-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataform.northamerica-northeast1.rep.googleapis.com/", +"location": "northamerica-northeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataform.northamerica-northeast2.rep.googleapis.com/", +"location": "northamerica-northeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataform.northamerica-south1.rep.googleapis.com/", +"location": "northamerica-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataform.southamerica-east1.rep.googleapis.com/", +"location": "southamerica-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataform.southamerica-west1.rep.googleapis.com/", +"location": "southamerica-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataform.us-central1.rep.googleapis.com/", +"location": "us-central1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataform.us-east1.rep.googleapis.com/", +"location": "us-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataform.us-east5.rep.googleapis.com/", +"location": "us-east5" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataform.us-east7.rep.googleapis.com/", +"location": "us-east7" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataform.us-south1.rep.googleapis.com/", +"location": "us-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataform.us-west1.rep.googleapis.com/", +"location": "us-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataform.us-west2.rep.googleapis.com/", +"location": "us-west2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataform.us-west3.rep.googleapis.com/", +"location": "us-west3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataform.us-west4.rep.googleapis.com/", +"location": "us-west4" +} +], "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", @@ -3018,7 +3225,7 @@ } } }, -"revision": "20260322", +"revision": "20260326", "rootUrl": "https://dataform.googleapis.com/", "schemas": { "ActionErrorTable": { diff --git a/googleapiclient/discovery_cache/documents/dataform.v1beta1.json b/googleapiclient/discovery_cache/documents/dataform.v1beta1.json index 4d3caa63bc..27b8ddfb98 100644 --- a/googleapiclient/discovery_cache/documents/dataform.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/dataform.v1beta1.json @@ -17,6 +17,213 @@ "description": "Service to develop, version control, and operationalize SQL pipelines in BigQuery.", "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/dataform/docs", +"endpoints": [ +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataform.africa-south1.rep.googleapis.com/", +"location": "africa-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataform.asia-east1.rep.googleapis.com/", +"location": "asia-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataform.asia-east2.rep.googleapis.com/", +"location": "asia-east2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataform.asia-northeast1.rep.googleapis.com/", +"location": "asia-northeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataform.asia-northeast2.rep.googleapis.com/", +"location": "asia-northeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataform.asia-northeast3.rep.googleapis.com/", +"location": "asia-northeast3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataform.asia-south1.rep.googleapis.com/", +"location": "asia-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataform.asia-south2.rep.googleapis.com/", +"location": "asia-south2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataform.asia-southeast1.rep.googleapis.com/", +"location": "asia-southeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataform.asia-southeast2.rep.googleapis.com/", +"location": "asia-southeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataform.australia-southeast1.rep.googleapis.com/", +"location": "australia-southeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataform.australia-southeast2.rep.googleapis.com/", +"location": "australia-southeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataform.europe-central2.rep.googleapis.com/", +"location": "europe-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataform.europe-north1.rep.googleapis.com/", +"location": "europe-north1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataform.europe-north2.rep.googleapis.com/", +"location": "europe-north2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataform.europe-southwest1.rep.googleapis.com/", +"location": "europe-southwest1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataform.europe-west1.rep.googleapis.com/", +"location": "europe-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataform.europe-west10.rep.googleapis.com/", +"location": "europe-west10" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataform.europe-west12.rep.googleapis.com/", +"location": "europe-west12" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataform.europe-west2.rep.googleapis.com/", +"location": "europe-west2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataform.europe-west3.rep.googleapis.com/", +"location": "europe-west3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataform.europe-west6.rep.googleapis.com/", +"location": "europe-west6" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataform.europe-west8.rep.googleapis.com/", +"location": "europe-west8" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataform.europe-west9.rep.googleapis.com/", +"location": "europe-west9" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataform.me-central1.rep.googleapis.com/", +"location": "me-central1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataform.me-central2.rep.googleapis.com/", +"location": "me-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataform.me-west1.rep.googleapis.com/", +"location": "me-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataform.northamerica-northeast1.rep.googleapis.com/", +"location": "northamerica-northeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataform.northamerica-northeast2.rep.googleapis.com/", +"location": "northamerica-northeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataform.northamerica-south1.rep.googleapis.com/", +"location": "northamerica-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataform.southamerica-east1.rep.googleapis.com/", +"location": "southamerica-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataform.southamerica-west1.rep.googleapis.com/", +"location": "southamerica-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataform.us-central1.rep.googleapis.com/", +"location": "us-central1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataform.us-east1.rep.googleapis.com/", +"location": "us-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataform.us-east5.rep.googleapis.com/", +"location": "us-east5" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataform.us-east7.rep.googleapis.com/", +"location": "us-east7" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataform.us-south1.rep.googleapis.com/", +"location": "us-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataform.us-west1.rep.googleapis.com/", +"location": "us-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataform.us-west2.rep.googleapis.com/", +"location": "us-west2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataform.us-west3.rep.googleapis.com/", +"location": "us-west3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataform.us-west4.rep.googleapis.com/", +"location": "us-west4" +} +], "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", @@ -3030,7 +3237,7 @@ } } }, -"revision": "20260322", +"revision": "20260326", "rootUrl": "https://dataform.googleapis.com/", "schemas": { "ActionErrorTable": { diff --git a/googleapiclient/discovery_cache/documents/dataplex.v1.json b/googleapiclient/discovery_cache/documents/dataplex.v1.json index 1741923c75..f70c167ec4 100644 --- a/googleapiclient/discovery_cache/documents/dataplex.v1.json +++ b/googleapiclient/discovery_cache/documents/dataplex.v1.json @@ -397,7 +397,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "delete": { @@ -427,7 +428,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "get": { @@ -452,7 +454,8 @@ "$ref": "GoogleCloudDataplexV1EncryptionConfig" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "getIamPolicy": { @@ -483,7 +486,8 @@ "$ref": "GoogleIamV1Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "list": { @@ -529,7 +533,8 @@ "$ref": "GoogleCloudDataplexV1ListEncryptionConfigsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "patch": { @@ -563,7 +568,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "setIamPolicy": { @@ -591,7 +597,8 @@ "$ref": "GoogleIamV1Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "testIamPermissions": { @@ -619,7 +626,8 @@ "$ref": "GoogleIamV1TestIamPermissionsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] } } @@ -651,7 +659,8 @@ "$ref": "Empty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "delete": { @@ -676,7 +685,8 @@ "$ref": "Empty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "get": { @@ -701,7 +711,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "list": { @@ -747,7 +758,8 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] } } @@ -782,11 +794,12 @@ "$ref": "GoogleCloudLocationLocation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "list": { -"description": "Lists information about the supported locations for this service. This method can be called in two ways: List all public locations: Use the path GET /v1/locations. List project-visible locations: Use the path GET /v1/projects/{project_id}/locations. This may include public locations as well as private or other locations specifically visible to the project.", +"description": "Lists information about the supported locations for this service.This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: Global locations: If name is empty, the method lists the public locations available to all projects. Project-specific locations: If name follows the format projects/{project}, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project.For gRPC and client library implementations, the resource name is passed as the name field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "flatPath": "v1/projects/{projectsId}/locations", "httpMethod": "GET", "id": "dataplex.projects.locations.list", @@ -829,7 +842,8 @@ "$ref": "GoogleCloudLocationListLocationsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "lookupContext": { @@ -858,6 +872,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/dataplex.read-write", "https://www.googleapis.com/auth/dataplex.readonly" ] @@ -985,7 +1000,37 @@ "$ref": "GoogleCloudDataplexV1LookupEntryLinksResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" +] +}, +"modifyEntry": { +"description": "Modifies an entry using the permission on the source system.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}:modifyEntry", +"httpMethod": "POST", +"id": "dataplex.projects.locations.modifyEntry", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The project to which the request should be attributed in the following form: projects/{project}/locations/{location}.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:modifyEntry", +"request": { +"$ref": "GoogleCloudDataplexV1ModifyEntryRequest" +}, +"response": { +"$ref": "GoogleCloudDataplexV1Entry" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "searchEntries": { @@ -1042,6 +1087,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/dataplex.read-write", "https://www.googleapis.com/auth/dataplex.readonly" ] @@ -1085,7 +1131,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "delete": { @@ -1115,7 +1162,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "get": { @@ -1140,7 +1188,10 @@ "$ref": "GoogleCloudDataplexV1AspectType" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only", +"https://www.googleapis.com/auth/dataplex.read-write", +"https://www.googleapis.com/auth/dataplex.readonly" ] }, "getIamPolicy": { @@ -1171,7 +1222,8 @@ "$ref": "GoogleIamV1Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "list": { @@ -1217,7 +1269,10 @@ "$ref": "GoogleCloudDataplexV1ListAspectTypesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only", +"https://www.googleapis.com/auth/dataplex.read-write", +"https://www.googleapis.com/auth/dataplex.readonly" ] }, "patch": { @@ -1256,7 +1311,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "setIamPolicy": { @@ -1284,7 +1340,8 @@ "$ref": "GoogleIamV1Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "testIamPermissions": { @@ -1312,7 +1369,8 @@ "$ref": "GoogleIamV1TestIamPermissionsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] } } @@ -1347,7 +1405,8 @@ "$ref": "GoogleIamV1Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "setIamPolicy": { @@ -1375,7 +1434,8 @@ "$ref": "GoogleIamV1Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "testIamPermissions": { @@ -1403,7 +1463,8 @@ "$ref": "GoogleIamV1TestIamPermissionsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] } } @@ -1446,7 +1507,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "delete": { @@ -1477,7 +1539,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "get": { @@ -1503,7 +1566,8 @@ "$ref": "GoogleCloudDataplexV1DataAttributeBinding" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "getIamPolicy": { @@ -1534,7 +1598,8 @@ "$ref": "GoogleIamV1Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "list": { @@ -1581,7 +1646,8 @@ "$ref": "GoogleCloudDataplexV1ListDataAttributeBindingsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "patch": { @@ -1621,7 +1687,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "setIamPolicy": { @@ -1649,7 +1716,8 @@ "$ref": "GoogleIamV1Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "testIamPermissions": { @@ -1677,7 +1745,102 @@ "$ref": "GoogleIamV1TestIamPermissionsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" +] +} +} +}, +"dataDomains": { +"methods": { +"getIamPolicy": { +"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataDomains/{dataDomainsId}:getIamPolicy", +"httpMethod": "GET", +"id": "dataplex.projects.locations.dataDomains.getIamPolicy", +"parameterOrder": [ +"resource" +], +"parameters": { +"options.requestedPolicyVersion": { +"description": "Optional. The maximum policy version that will be used to format the policy.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset.The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).", +"format": "int32", +"location": "query", +"type": "integer" +}, +"resource": { +"description": "REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/dataDomains/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:getIamPolicy", +"response": { +"$ref": "GoogleIamV1Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" +] +}, +"setIamPolicy": { +"description": "Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataDomains/{dataDomainsId}:setIamPolicy", +"httpMethod": "POST", +"id": "dataplex.projects.locations.dataDomains.setIamPolicy", +"parameterOrder": [ +"resource" +], +"parameters": { +"resource": { +"description": "REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/dataDomains/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:setIamPolicy", +"request": { +"$ref": "GoogleIamV1SetIamPolicyRequest" +}, +"response": { +"$ref": "GoogleIamV1Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" +] +}, +"testIamPermissions": { +"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataDomains/{dataDomainsId}:testIamPermissions", +"httpMethod": "POST", +"id": "dataplex.projects.locations.dataDomains.testIamPermissions", +"parameterOrder": [ +"resource" +], +"parameters": { +"resource": { +"description": "REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/dataDomains/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:testIamPermissions", +"request": { +"$ref": "GoogleIamV1TestIamPermissionsRequest" +}, +"response": { +"$ref": "GoogleIamV1TestIamPermissionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] } } @@ -1719,7 +1882,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "delete": { @@ -1754,7 +1918,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "get": { @@ -1779,7 +1944,10 @@ "$ref": "GoogleCloudDataplexV1DataProduct" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only", +"https://www.googleapis.com/auth/dataplex.read-write", +"https://www.googleapis.com/auth/dataplex.readonly" ] }, "getIamPolicy": { @@ -1810,7 +1978,8 @@ "$ref": "GoogleIamV1Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "list": { @@ -1856,7 +2025,10 @@ "$ref": "GoogleCloudDataplexV1ListDataProductsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only", +"https://www.googleapis.com/auth/dataplex.read-write", +"https://www.googleapis.com/auth/dataplex.readonly" ] }, "patch": { @@ -1895,7 +2067,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "setIamPolicy": { @@ -1923,7 +2096,8 @@ "$ref": "GoogleIamV1Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "testIamPermissions": { @@ -1951,7 +2125,8 @@ "$ref": "GoogleIamV1TestIamPermissionsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] } }, @@ -1993,7 +2168,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "delete": { @@ -2028,7 +2204,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "get": { @@ -2053,7 +2230,10 @@ "$ref": "GoogleCloudDataplexV1DataAsset" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only", +"https://www.googleapis.com/auth/dataplex.read-write", +"https://www.googleapis.com/auth/dataplex.readonly" ] }, "list": { @@ -2099,7 +2279,10 @@ "$ref": "GoogleCloudDataplexV1ListDataAssetsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only", +"https://www.googleapis.com/auth/dataplex.read-write", +"https://www.googleapis.com/auth/dataplex.readonly" ] }, "patch": { @@ -2138,7 +2321,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] } } @@ -2182,7 +2366,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "delete": { @@ -2212,7 +2397,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "generateDataQualityRules": { @@ -2240,7 +2426,8 @@ "$ref": "GoogleCloudDataplexV1GenerateDataQualityRulesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "get": { @@ -2280,7 +2467,10 @@ "$ref": "GoogleCloudDataplexV1DataScan" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only", +"https://www.googleapis.com/auth/dataplex.read-write", +"https://www.googleapis.com/auth/dataplex.readonly" ] }, "getIamPolicy": { @@ -2311,7 +2501,8 @@ "$ref": "GoogleIamV1Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "list": { @@ -2357,7 +2548,10 @@ "$ref": "GoogleCloudDataplexV1ListDataScansResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only", +"https://www.googleapis.com/auth/dataplex.read-write", +"https://www.googleapis.com/auth/dataplex.readonly" ] }, "patch": { @@ -2396,7 +2590,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "run": { @@ -2424,7 +2619,8 @@ "$ref": "GoogleCloudDataplexV1RunDataScanResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "setIamPolicy": { @@ -2452,7 +2648,8 @@ "$ref": "GoogleIamV1Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "testIamPermissions": { @@ -2480,7 +2677,8 @@ "$ref": "GoogleIamV1TestIamPermissionsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] } }, @@ -2512,7 +2710,8 @@ "$ref": "GoogleCloudDataplexV1GenerateDataQualityRulesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "get": { @@ -2552,7 +2751,10 @@ "$ref": "GoogleCloudDataplexV1DataScanJob" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only", +"https://www.googleapis.com/auth/dataplex.read-write", +"https://www.googleapis.com/auth/dataplex.readonly" ] }, "list": { @@ -2593,7 +2795,10 @@ "$ref": "GoogleCloudDataplexV1ListDataScanJobsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only", +"https://www.googleapis.com/auth/dataplex.read-write", +"https://www.googleapis.com/auth/dataplex.readonly" ] } } @@ -2637,7 +2842,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "delete": { @@ -2668,7 +2874,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "get": { @@ -2693,7 +2900,8 @@ "$ref": "GoogleCloudDataplexV1DataTaxonomy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "getIamPolicy": { @@ -2724,7 +2932,8 @@ "$ref": "GoogleIamV1Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "list": { @@ -2771,7 +2980,8 @@ "$ref": "GoogleCloudDataplexV1ListDataTaxonomiesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "patch": { @@ -2811,7 +3021,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "setIamPolicy": { @@ -2839,7 +3050,8 @@ "$ref": "GoogleIamV1Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "testIamPermissions": { @@ -2867,7 +3079,8 @@ "$ref": "GoogleIamV1TestIamPermissionsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] } }, @@ -2910,7 +3123,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "delete": { @@ -2941,7 +3155,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "get": { @@ -2967,7 +3182,8 @@ "$ref": "GoogleCloudDataplexV1DataAttribute" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "getIamPolicy": { @@ -2998,7 +3214,8 @@ "$ref": "GoogleIamV1Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "list": { @@ -3045,7 +3262,8 @@ "$ref": "GoogleCloudDataplexV1ListDataAttributesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "patch": { @@ -3085,7 +3303,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "setIamPolicy": { @@ -3113,7 +3332,8 @@ "$ref": "GoogleIamV1Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "testIamPermissions": { @@ -3141,7 +3361,8 @@ "$ref": "GoogleIamV1TestIamPermissionsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] } } @@ -3185,7 +3406,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "delete": { @@ -3215,7 +3437,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "get": { @@ -3240,7 +3463,10 @@ "$ref": "GoogleCloudDataplexV1EntryGroup" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only", +"https://www.googleapis.com/auth/dataplex.read-write", +"https://www.googleapis.com/auth/dataplex.readonly" ] }, "getIamPolicy": { @@ -3271,7 +3497,8 @@ "$ref": "GoogleIamV1Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "list": { @@ -3317,7 +3544,10 @@ "$ref": "GoogleCloudDataplexV1ListEntryGroupsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only", +"https://www.googleapis.com/auth/dataplex.read-write", +"https://www.googleapis.com/auth/dataplex.readonly" ] }, "patch": { @@ -3356,7 +3586,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "setIamPolicy": { @@ -3384,7 +3615,8 @@ "$ref": "GoogleIamV1Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "testIamPermissions": { @@ -3412,7 +3644,8 @@ "$ref": "GoogleIamV1TestIamPermissionsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] } }, @@ -3449,7 +3682,8 @@ "$ref": "GoogleCloudDataplexV1Entry" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "delete": { @@ -3474,7 +3708,8 @@ "$ref": "GoogleCloudDataplexV1Entry" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "get": { @@ -3530,7 +3765,10 @@ "$ref": "GoogleCloudDataplexV1Entry" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only", +"https://www.googleapis.com/auth/dataplex.read-write", +"https://www.googleapis.com/auth/dataplex.readonly" ] }, "list": { @@ -3571,7 +3809,10 @@ "$ref": "GoogleCloudDataplexV1ListEntriesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only", +"https://www.googleapis.com/auth/dataplex.read-write", +"https://www.googleapis.com/auth/dataplex.readonly" ] }, "patch": { @@ -3621,7 +3862,8 @@ "$ref": "GoogleCloudDataplexV1Entry" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] } } @@ -3658,7 +3900,8 @@ "$ref": "GoogleCloudDataplexV1EntryLink" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "delete": { @@ -3683,7 +3926,8 @@ "$ref": "GoogleCloudDataplexV1EntryLink" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "get": { @@ -3708,7 +3952,8 @@ "$ref": "GoogleCloudDataplexV1EntryLink" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "patch": { @@ -3747,7 +3992,8 @@ "$ref": "GoogleCloudDataplexV1EntryLink" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] } } @@ -3784,7 +4030,8 @@ "$ref": "GoogleIamV1Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "setIamPolicy": { @@ -3812,7 +4059,8 @@ "$ref": "GoogleIamV1Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "testIamPermissions": { @@ -3840,7 +4088,8 @@ "$ref": "GoogleIamV1TestIamPermissionsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] } } @@ -3882,7 +4131,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "delete": { @@ -3912,7 +4162,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "get": { @@ -3937,7 +4188,10 @@ "$ref": "GoogleCloudDataplexV1EntryType" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only", +"https://www.googleapis.com/auth/dataplex.read-write", +"https://www.googleapis.com/auth/dataplex.readonly" ] }, "getIamPolicy": { @@ -3968,7 +4222,8 @@ "$ref": "GoogleIamV1Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "list": { @@ -4014,7 +4269,10 @@ "$ref": "GoogleCloudDataplexV1ListEntryTypesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only", +"https://www.googleapis.com/auth/dataplex.read-write", +"https://www.googleapis.com/auth/dataplex.readonly" ] }, "patch": { @@ -4053,7 +4311,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "setIamPolicy": { @@ -4081,7 +4340,8 @@ "$ref": "GoogleIamV1Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "testIamPermissions": { @@ -4109,7 +4369,8 @@ "$ref": "GoogleIamV1TestIamPermissionsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] } } @@ -4151,7 +4412,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "delete": { @@ -4181,7 +4443,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "get": { @@ -4206,7 +4469,10 @@ "$ref": "GoogleCloudDataplexV1Glossary" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only", +"https://www.googleapis.com/auth/dataplex.read-write", +"https://www.googleapis.com/auth/dataplex.readonly" ] }, "getIamPolicy": { @@ -4237,7 +4503,8 @@ "$ref": "GoogleIamV1Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "list": { @@ -4283,7 +4550,10 @@ "$ref": "GoogleCloudDataplexV1ListGlossariesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only", +"https://www.googleapis.com/auth/dataplex.read-write", +"https://www.googleapis.com/auth/dataplex.readonly" ] }, "patch": { @@ -4322,7 +4592,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "setIamPolicy": { @@ -4350,7 +4621,8 @@ "$ref": "GoogleIamV1Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "testIamPermissions": { @@ -4378,7 +4650,8 @@ "$ref": "GoogleIamV1TestIamPermissionsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] } }, @@ -4415,7 +4688,8 @@ "$ref": "GoogleCloudDataplexV1GlossaryCategory" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "delete": { @@ -4440,7 +4714,8 @@ "$ref": "Empty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "get": { @@ -4465,7 +4740,10 @@ "$ref": "GoogleCloudDataplexV1GlossaryCategory" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only", +"https://www.googleapis.com/auth/dataplex.read-write", +"https://www.googleapis.com/auth/dataplex.readonly" ] }, "getIamPolicy": { @@ -4496,7 +4774,8 @@ "$ref": "GoogleIamV1Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "list": { @@ -4542,7 +4821,10 @@ "$ref": "GoogleCloudDataplexV1ListGlossaryCategoriesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only", +"https://www.googleapis.com/auth/dataplex.read-write", +"https://www.googleapis.com/auth/dataplex.readonly" ] }, "patch": { @@ -4576,7 +4858,8 @@ "$ref": "GoogleCloudDataplexV1GlossaryCategory" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "setIamPolicy": { @@ -4604,7 +4887,8 @@ "$ref": "GoogleIamV1Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "testIamPermissions": { @@ -4632,7 +4916,8 @@ "$ref": "GoogleIamV1TestIamPermissionsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] } } @@ -4669,7 +4954,8 @@ "$ref": "GoogleCloudDataplexV1GlossaryTerm" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "delete": { @@ -4694,7 +4980,8 @@ "$ref": "Empty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "get": { @@ -4719,7 +5006,10 @@ "$ref": "GoogleCloudDataplexV1GlossaryTerm" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only", +"https://www.googleapis.com/auth/dataplex.read-write", +"https://www.googleapis.com/auth/dataplex.readonly" ] }, "getIamPolicy": { @@ -4750,7 +5040,8 @@ "$ref": "GoogleIamV1Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "list": { @@ -4796,7 +5087,10 @@ "$ref": "GoogleCloudDataplexV1ListGlossaryTermsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only", +"https://www.googleapis.com/auth/dataplex.read-write", +"https://www.googleapis.com/auth/dataplex.readonly" ] }, "patch": { @@ -4830,7 +5124,8 @@ "$ref": "GoogleCloudDataplexV1GlossaryTerm" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "setIamPolicy": { @@ -4858,7 +5153,8 @@ "$ref": "GoogleIamV1Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "testIamPermissions": { @@ -4886,7 +5182,8 @@ "$ref": "GoogleIamV1TestIamPermissionsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] } } @@ -4923,7 +5220,8 @@ "$ref": "GoogleIamV1Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "setIamPolicy": { @@ -4951,7 +5249,8 @@ "$ref": "GoogleIamV1Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "testIamPermissions": { @@ -4979,7 +5278,8 @@ "$ref": "GoogleIamV1TestIamPermissionsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] } } @@ -5021,7 +5321,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "delete": { @@ -5046,7 +5347,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "get": { @@ -5071,7 +5373,10 @@ "$ref": "GoogleCloudDataplexV1Lake" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only", +"https://www.googleapis.com/auth/dataplex.read-write", +"https://www.googleapis.com/auth/dataplex.readonly" ] }, "getIamPolicy": { @@ -5102,7 +5407,8 @@ "$ref": "GoogleIamV1Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "list": { @@ -5148,7 +5454,10 @@ "$ref": "GoogleCloudDataplexV1ListLakesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only", +"https://www.googleapis.com/auth/dataplex.read-write", +"https://www.googleapis.com/auth/dataplex.readonly" ] }, "patch": { @@ -5187,7 +5496,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "setIamPolicy": { @@ -5215,7 +5525,8 @@ "$ref": "GoogleIamV1Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "testIamPermissions": { @@ -5240,141 +5551,54 @@ "$ref": "GoogleIamV1TestIamPermissionsRequest" }, "response": { -"$ref": "GoogleIamV1TestIamPermissionsResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -} -}, -"resources": { -"actions": { -"methods": { -"list": { -"description": "Lists action resources in a lake.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/actions", -"httpMethod": "GET", -"id": "dataplex.projects.locations.lakes.actions.list", -"parameterOrder": [ -"parent" -], -"parameters": { -"pageSize": { -"description": "Optional. Maximum number of actions to return. The service may return fewer than this value. If unspecified, at most 10 actions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", -"format": "int32", -"location": "query", -"type": "integer" -}, -"pageToken": { -"description": "Optional. Page token received from a previous ListLakeActions call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListLakeActions must match the call that provided the page token.", -"location": "query", -"type": "string" -}, -"parent": { -"description": "Required. The resource name of the parent lake: projects/{project_number}/locations/{location_id}/lakes/{lake_id}.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+parent}/actions", -"response": { -"$ref": "GoogleCloudDataplexV1ListActionsResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -} -} -}, -"environments": { -"methods": { -"getIamPolicy": { -"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/environments/{environmentsId}:getIamPolicy", -"httpMethod": "GET", -"id": "dataplex.projects.locations.lakes.environments.getIamPolicy", -"parameterOrder": [ -"resource" -], -"parameters": { -"options.requestedPolicyVersion": { -"description": "Optional. The maximum policy version that will be used to format the policy.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset.The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).", -"format": "int32", -"location": "query", -"type": "integer" -}, -"resource": { -"description": "REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+/environments/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+resource}:getIamPolicy", -"response": { -"$ref": "GoogleIamV1Policy" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"setIamPolicy": { -"description": "Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/environments/{environmentsId}:setIamPolicy", -"httpMethod": "POST", -"id": "dataplex.projects.locations.lakes.environments.setIamPolicy", -"parameterOrder": [ -"resource" -], -"parameters": { -"resource": { -"description": "REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+/environments/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+resource}:setIamPolicy", -"request": { -"$ref": "GoogleIamV1SetIamPolicyRequest" -}, -"response": { -"$ref": "GoogleIamV1Policy" +"$ref": "GoogleIamV1TestIamPermissionsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] +} }, -"testIamPermissions": { -"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/environments/{environmentsId}:testIamPermissions", -"httpMethod": "POST", -"id": "dataplex.projects.locations.lakes.environments.testIamPermissions", +"resources": { +"actions": { +"methods": { +"list": { +"description": "Lists action resources in a lake.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/actions", +"httpMethod": "GET", +"id": "dataplex.projects.locations.lakes.actions.list", "parameterOrder": [ -"resource" +"parent" ], "parameters": { -"resource": { -"description": "REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"pageSize": { +"description": "Optional. Maximum number of actions to return. The service may return fewer than this value. If unspecified, at most 10 actions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. Page token received from a previous ListLakeActions call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListLakeActions must match the call that provided the page token.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The resource name of the parent lake: projects/{project_number}/locations/{location_id}/lakes/{lake_id}.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+/environments/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+$", "required": true, "type": "string" } }, -"path": "v1/{+resource}:testIamPermissions", -"request": { -"$ref": "GoogleIamV1TestIamPermissionsRequest" -}, +"path": "v1/{+parent}/actions", "response": { -"$ref": "GoogleIamV1TestIamPermissionsResponse" +"$ref": "GoogleCloudDataplexV1ListActionsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only", +"https://www.googleapis.com/auth/dataplex.read-write", +"https://www.googleapis.com/auth/dataplex.readonly" ] } } @@ -5416,7 +5640,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "delete": { @@ -5441,7 +5666,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "get": { @@ -5466,7 +5692,10 @@ "$ref": "GoogleCloudDataplexV1Task" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only", +"https://www.googleapis.com/auth/dataplex.read-write", +"https://www.googleapis.com/auth/dataplex.readonly" ] }, "getIamPolicy": { @@ -5497,7 +5726,8 @@ "$ref": "GoogleIamV1Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "list": { @@ -5543,7 +5773,10 @@ "$ref": "GoogleCloudDataplexV1ListTasksResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only", +"https://www.googleapis.com/auth/dataplex.read-write", +"https://www.googleapis.com/auth/dataplex.readonly" ] }, "patch": { @@ -5582,7 +5815,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "run": { @@ -5610,7 +5844,8 @@ "$ref": "GoogleCloudDataplexV1RunTaskResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "setIamPolicy": { @@ -5638,7 +5873,8 @@ "$ref": "GoogleIamV1Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "testIamPermissions": { @@ -5666,7 +5902,8 @@ "$ref": "GoogleIamV1TestIamPermissionsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] } }, @@ -5698,7 +5935,8 @@ "$ref": "Empty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "get": { @@ -5723,7 +5961,10 @@ "$ref": "GoogleCloudDataplexV1Job" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only", +"https://www.googleapis.com/auth/dataplex.read-write", +"https://www.googleapis.com/auth/dataplex.readonly" ] }, "list": { @@ -5759,7 +6000,10 @@ "$ref": "GoogleCloudDataplexV1ListJobsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only", +"https://www.googleapis.com/auth/dataplex.read-write", +"https://www.googleapis.com/auth/dataplex.readonly" ] } } @@ -5803,7 +6047,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "delete": { @@ -5828,7 +6073,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "get": { @@ -5853,7 +6099,10 @@ "$ref": "GoogleCloudDataplexV1Zone" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only", +"https://www.googleapis.com/auth/dataplex.read-write", +"https://www.googleapis.com/auth/dataplex.readonly" ] }, "getIamPolicy": { @@ -5884,7 +6133,8 @@ "$ref": "GoogleIamV1Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "list": { @@ -5930,7 +6180,10 @@ "$ref": "GoogleCloudDataplexV1ListZonesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only", +"https://www.googleapis.com/auth/dataplex.read-write", +"https://www.googleapis.com/auth/dataplex.readonly" ] }, "patch": { @@ -5969,7 +6222,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "setIamPolicy": { @@ -5997,7 +6251,8 @@ "$ref": "GoogleIamV1Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "testIamPermissions": { @@ -6025,7 +6280,8 @@ "$ref": "GoogleIamV1TestIamPermissionsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] } }, @@ -6065,7 +6321,10 @@ "$ref": "GoogleCloudDataplexV1ListActionsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only", +"https://www.googleapis.com/auth/dataplex.read-write", +"https://www.googleapis.com/auth/dataplex.readonly" ] } } @@ -6107,7 +6366,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "delete": { @@ -6132,7 +6392,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "get": { @@ -6157,7 +6418,10 @@ "$ref": "GoogleCloudDataplexV1Asset" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only", +"https://www.googleapis.com/auth/dataplex.read-write", +"https://www.googleapis.com/auth/dataplex.readonly" ] }, "getIamPolicy": { @@ -6188,7 +6452,8 @@ "$ref": "GoogleIamV1Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "list": { @@ -6234,7 +6499,10 @@ "$ref": "GoogleCloudDataplexV1ListAssetsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only", +"https://www.googleapis.com/auth/dataplex.read-write", +"https://www.googleapis.com/auth/dataplex.readonly" ] }, "patch": { @@ -6273,7 +6541,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "setIamPolicy": { @@ -6301,7 +6570,8 @@ "$ref": "GoogleIamV1Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "testIamPermissions": { @@ -6329,7 +6599,8 @@ "$ref": "GoogleIamV1TestIamPermissionsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] } }, @@ -6369,7 +6640,10 @@ "$ref": "GoogleCloudDataplexV1ListActionsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only", +"https://www.googleapis.com/auth/dataplex.read-write", +"https://www.googleapis.com/auth/dataplex.readonly" ] } } @@ -6408,7 +6682,8 @@ "$ref": "GoogleCloudDataplexV1Entity" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "delete": { @@ -6438,7 +6713,8 @@ "$ref": "Empty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "get": { @@ -6480,7 +6756,8 @@ "$ref": "GoogleCloudDataplexV1Entity" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "list": { @@ -6536,7 +6813,8 @@ "$ref": "GoogleCloudDataplexV1ListEntitiesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "update": { @@ -6569,7 +6847,8 @@ "$ref": "GoogleCloudDataplexV1Entity" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] } }, @@ -6606,7 +6885,8 @@ "$ref": "GoogleCloudDataplexV1Partition" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "delete": { @@ -6637,7 +6917,8 @@ "$ref": "Empty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "get": { @@ -6662,7 +6943,8 @@ "$ref": "GoogleCloudDataplexV1Partition" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "list": { @@ -6703,7 +6985,8 @@ "$ref": "GoogleCloudDataplexV1ListPartitionsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] } } @@ -6751,7 +7034,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "delete": { @@ -6776,7 +7060,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "get": { @@ -6801,7 +7086,8 @@ "$ref": "GoogleCloudDataplexV1MetadataFeed" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "list": { @@ -6847,7 +7133,8 @@ "$ref": "GoogleCloudDataplexV1ListMetadataFeedsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "patch": { @@ -6886,7 +7173,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] } } @@ -6918,7 +7206,8 @@ "$ref": "Empty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "create": { @@ -6956,7 +7245,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "get": { @@ -6981,7 +7271,8 @@ "$ref": "GoogleCloudDataplexV1MetadataJob" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "list": { @@ -7027,7 +7318,8 @@ "$ref": "GoogleCloudDataplexV1ListMetadataJobsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] } } @@ -7059,7 +7351,8 @@ "$ref": "Empty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "delete": { @@ -7084,7 +7377,8 @@ "$ref": "Empty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "get": { @@ -7109,7 +7403,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "list": { @@ -7155,7 +7450,8 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] } } @@ -7190,7 +7486,8 @@ "$ref": "GoogleIamV1Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "setIamPolicy": { @@ -7218,7 +7515,8 @@ "$ref": "GoogleIamV1Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] }, "testIamPermissions": { @@ -7246,7 +7544,8 @@ "$ref": "GoogleIamV1TestIamPermissionsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" ] } } @@ -7256,7 +7555,7 @@ } } }, -"revision": "20260310", +"revision": "20260402", "rootUrl": "https://dataplex.googleapis.com/", "schemas": { "Empty": { @@ -7475,7 +7774,7 @@ "type": "object" }, "GoogleCloudDataplexV1Aspect": { -"description": "An aspect is a single piece of metadata describing an entry.", +"description": "Represents a single piece of metadata describing an entry or entry link.", "id": "GoogleCloudDataplexV1Aspect", "properties": { "aspectSource": { @@ -8563,6 +8862,10 @@ "jsonOptions": { "$ref": "GoogleCloudDataplexV1DataDiscoverySpecStorageConfigJsonOptions", "description": "Optional. Configuration for JSON data." +}, +"unstructuredDataOptions": { +"$ref": "GoogleCloudDataplexV1DataDiscoverySpecStorageConfigUnstructuredDataOptions", +"description": "Optional. Specifies configuration for unstructured data discovery." } }, "type": "object" @@ -8610,18 +8913,67 @@ }, "type": "object" }, +"GoogleCloudDataplexV1DataDiscoverySpecStorageConfigUnstructuredDataOptions": { +"description": "Describes options for unstructured data discovery.", +"id": "GoogleCloudDataplexV1DataDiscoverySpecStorageConfigUnstructuredDataOptions", +"properties": { +"entityInferenceEnabled": { +"deprecated": true, +"description": "Optional. Deprecated: Use semantic_inference_enabled instead. Specifies whether deeper entity inference over the objects' contents using GenAI is enabled.", +"type": "boolean" +}, +"semanticInferenceEnabled": { +"description": "Optional. Specifies whether deeper semantic inference over the objects' contents using GenAI is enabled.", +"type": "boolean" +} +}, +"type": "object" +}, "GoogleCloudDataplexV1DataDocumentationResult": { "description": "The output of a DataDocumentation scan.", "id": "GoogleCloudDataplexV1DataDocumentationResult", "properties": { +"datasetResult": { +"$ref": "GoogleCloudDataplexV1DataDocumentationResultDatasetResult", +"description": "Output only. Insights for a Dataset resource.", +"readOnly": true +}, "tableResult": { "$ref": "GoogleCloudDataplexV1DataDocumentationResultTableResult", -"description": "Output only. Table result for insights.", +"description": "Output only. Insights for a Table resource.", "readOnly": true } }, "type": "object" }, +"GoogleCloudDataplexV1DataDocumentationResultDatasetResult": { +"description": "Insights for a dataset resource.", +"id": "GoogleCloudDataplexV1DataDocumentationResultDatasetResult", +"properties": { +"overview": { +"description": "Output only. Generated Dataset description.", +"readOnly": true, +"type": "string" +}, +"queries": { +"description": "Output only. Sample SQL queries for the dataset.", +"items": { +"$ref": "GoogleCloudDataplexV1DataDocumentationResultQuery" +}, +"readOnly": true, +"type": "array" +}, +"schemaRelationships": { +"description": "Output only. Relationships suggesting how tables in the dataset are related to each other, based on their schema.", +"items": { +"$ref": "GoogleCloudDataplexV1DataDocumentationResultSchemaRelationship" +}, +"readOnly": true, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudDataplexV1DataDocumentationResultField": { "description": "Column of a table with generated metadata and nested fields.", "id": "GoogleCloudDataplexV1DataDocumentationResultField", @@ -8679,8 +9031,78 @@ }, "type": "object" }, +"GoogleCloudDataplexV1DataDocumentationResultSchemaRelationship": { +"description": "Details of the relationship between the schema of two resources.", +"id": "GoogleCloudDataplexV1DataDocumentationResultSchemaRelationship", +"properties": { +"leftSchemaPaths": { +"$ref": "GoogleCloudDataplexV1DataDocumentationResultSchemaRelationshipSchemaPaths", +"description": "Output only. An ordered list of fields for the join from the first table. The size of this list must be the same as right_schema_paths. Each field at index i in this list must correspond to a field at the same index in the right_schema_paths list.", +"readOnly": true +}, +"rightSchemaPaths": { +"$ref": "GoogleCloudDataplexV1DataDocumentationResultSchemaRelationshipSchemaPaths", +"description": "Output only. An ordered list of fields for the join from the second table. The size of this list must be the same as left_schema_paths. Each field at index i in this list must correspond to a field at the same index in the left_schema_paths list.", +"readOnly": true +}, +"sources": { +"description": "Output only. Sources which generated the schema relation edge.", +"items": { +"enum": [ +"SOURCE_UNSPECIFIED", +"AGENT", +"QUERY_HISTORY", +"TABLE_CONSTRAINTS" +], +"enumDescriptions": [ +"The source of the schema relationship is unspecified.", +"The source of the schema relationship is agent.", +"The source of the schema relationship is query history from the source system.", +"The source of the schema relationship is table constraints added in the source system." +], +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"type": { +"description": "Output only. The type of relationship between the schema paths.", +"enum": [ +"TYPE_UNSPECIFIED", +"SCHEMA_JOIN" +], +"enumDescriptions": [ +"The type of the schema relationship is unspecified.", +"Indicates a join relationship between the schema fields." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDataplexV1DataDocumentationResultSchemaRelationshipSchemaPaths": { +"description": "Represents an ordered set of paths within a table's schema.", +"id": "GoogleCloudDataplexV1DataDocumentationResultSchemaRelationshipSchemaPaths", +"properties": { +"paths": { +"description": "Output only. An ordered set of Paths to fields within the schema of the table. For fields nested within a top level field of type record, use '.' to separate field names. Examples: Top level field - top_level Nested field - top_level.child.sub_field", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"tableFqn": { +"description": "Output only. The service-qualified full resource name of the table Ex: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDataplexV1DataDocumentationResultTableResult": { -"description": "Generated metadata about the table.", +"description": "Insights for a table resource.", "id": "GoogleCloudDataplexV1DataDocumentationResultTableResult", "properties": { "name": { @@ -9145,6 +9567,20 @@ "$ref": "GoogleCloudDataplexV1DataProfileSpecSelectedFields", "description": "Optional. The fields to include in data profile.If not specified, all fields at the time of profile scan job execution are included, except for ones listed in exclude_fields." }, +"mode": { +"description": "Optional. The execution mode for the profile scan.", +"enum": [ +"MODE_UNSPECIFIED", +"STANDARD", +"LIGHTWEIGHT" +], +"enumDescriptions": [ +"Default value. This value is unused.", +"Performs standard profiling. The behavior is controlled by other fields such as sampling_percent, row_filter, and column filters. This mode allows for full scans or custom sampling.", +"Specifies lightweight profiling mode. This mode is optimized for low-latency low-fidelity profiling.When this mode is selected, the following fields must not be set: - sampling_percent - row_filter - include_fields - exclude_fields" +], +"type": "string" +}, "postScanActions": { "$ref": "GoogleCloudDataplexV1DataProfileSpecPostScanActions", "description": "Optional. Actions to take upon job completion.." @@ -9946,7 +10382,7 @@ "type": "object" }, "GoogleCloudDataplexV1DataScan": { -"description": "Represents a user-visible job which provides the insights for the related data source.For example: Data quality: generates queries based on the rules and runs against the data to get data quality check results. For more information, see Auto data quality overview (https://cloud.google.com/dataplex/docs/auto-data-quality-overview). Data profile: analyzes the data in tables and generates insights about the structure, content and relationships (such as null percent, cardinality, min/max/mean, etc). For more information, see About data profiling (https://cloud.google.com/dataplex/docs/data-profiling-overview). Data discovery: scans data in Cloud Storage buckets to extract and then catalog metadata. For more information, see Discover and catalog Cloud Storage data (https://cloud.google.com/bigquery/docs/automatic-discovery). Data documentation: analyzes the table details and generates insights including descriptions and sample SQL queries for the table. For more information, see Generate data insights in BigQuery (https://cloud.google.com/bigquery/docs/data-insights).", +"description": "Represents a user-visible job which provides the insights for the related data source.For example: Data quality: generates queries based on the rules and runs against the data to get data quality check results. For more information, see Auto data quality overview (https://cloud.google.com/dataplex/docs/auto-data-quality-overview). Data profile: analyzes the data in tables and generates insights about the structure, content and relationships (such as null percent, cardinality, min/max/mean, etc). For more information, see About data profiling (https://cloud.google.com/dataplex/docs/data-profiling-overview). Data discovery: scans data in Cloud Storage buckets to extract and then catalog metadata. For more information, see Discover and catalog Cloud Storage data (https://cloud.google.com/bigquery/docs/automatic-discovery). Data documentation: analyzes the table or dataset metadata and generates insights. For tables, insights include descriptions and sample SQL queries. For datasets, insights include descriptions, schema relationships and sample SQL queries. For more information, see Generate data insights in BigQuery (https://cloud.google.com/bigquery/docs/data-insights).", "id": "GoogleCloudDataplexV1DataScan", "properties": { "createTime": { @@ -10003,6 +10439,10 @@ "description": "Optional. User friendly display name. Must be between 1-256 characters.", "type": "string" }, +"executionIdentity": { +"$ref": "GoogleCloudDataplexV1ExecutionIdentity", +"description": "Optional. Immutable. The identity to run the datascan. If not specified, defaults to the Dataplex Service Agent." +}, "executionSpec": { "$ref": "GoogleCloudDataplexV1DataScanExecutionSpec", "description": "Optional. DataScan execution settings.If not specified, the fields in it will use their default values." @@ -10461,6 +10901,11 @@ "readOnly": true, "type": "string" }, +"partialFailureMessage": { +"description": "Output only. A message indicating partial failure details.", +"readOnly": true, +"type": "string" +}, "startTime": { "description": "Output only. The time when the DataScanJob was started.", "format": "google-datetime", @@ -10476,7 +10921,8 @@ "CANCELLED", "SUCCEEDED", "FAILED", -"PENDING" +"PENDING", +"SUCCEEDED_WITH_ERRORS" ], "enumDescriptions": [ "The DataScanJob state is unspecified.", @@ -10485,7 +10931,8 @@ "The DataScanJob cancellation was successful.", "The DataScanJob completed successfully.", "The DataScanJob is no longer running due to an error.", -"The DataScanJob has been created but not started to run yet." +"The DataScanJob has been created but not started to run yet.", +"The DataScanJob succeeded with errors." ], "readOnly": true, "type": "string" @@ -10526,7 +10973,7 @@ "type": "string" }, "resource": { -"description": "Immutable. The service-qualified full resource name of the cloud resource for a DataScan job to scan against. The field could either be: Cloud Storage bucket for DataDiscoveryScan Format: //storage.googleapis.com/projects/PROJECT_ID/buckets/BUCKET_ID or BigQuery table of type \"TABLE\" for DataProfileScan/DataQualityScan/DataDocumentationScan Format: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID", +"description": "Immutable. The service-qualified full resource name of the cloud resource for a DataScan job to scan against. The field could either be: Cloud Storage bucket for DataDiscoveryScan Format: //storage.googleapis.com/projects/PROJECT_ID/buckets/BUCKET_ID or BigQuery table of type \"TABLE\" for DataProfileScan/DataQualityScan/DataDocumentationScan Format: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID or BigQuery dataset for DataDocumentationScan only Format: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID", "type": "string" } }, @@ -11394,6 +11841,48 @@ }, "type": "object" }, +"GoogleCloudDataplexV1ExecutionIdentity": { +"description": "The identity to run the datascan.", +"id": "GoogleCloudDataplexV1ExecutionIdentity", +"properties": { +"dataplexServiceAgent": { +"$ref": "GoogleCloudDataplexV1ExecutionIdentityDataplexServiceAgent", +"description": "Optional. The Dataplex service agent associated with the user's project." +}, +"serviceAccount": { +"$ref": "GoogleCloudDataplexV1ExecutionIdentityServiceAccount", +"description": "Optional. The provided service account." +}, +"userCredential": { +"$ref": "GoogleCloudDataplexV1ExecutionIdentityUserCredential", +"description": "Optional. The credential of the calling user. Supports only ONE_TIME trigger type." +} +}, +"type": "object" +}, +"GoogleCloudDataplexV1ExecutionIdentityDataplexServiceAgent": { +"description": "The Dataplex service agent associated with the user's project.", +"id": "GoogleCloudDataplexV1ExecutionIdentityDataplexServiceAgent", +"properties": {}, +"type": "object" +}, +"GoogleCloudDataplexV1ExecutionIdentityServiceAccount": { +"description": "The service account", +"id": "GoogleCloudDataplexV1ExecutionIdentityServiceAccount", +"properties": { +"email": { +"description": "Required. Service account email. The datascan will execute with this service account's credentials. The user calling this API must have permissions to act as this service account. Dataplex service agent must be granted iam.serviceAccounts.getAccessToken permission on this service account, for example, through the iam.serviceAccountTokenCreator role .", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDataplexV1ExecutionIdentityUserCredential": { +"description": "The credential of the calling user.", +"id": "GoogleCloudDataplexV1ExecutionIdentityUserCredential", +"properties": {}, +"type": "object" +}, "GoogleCloudDataplexV1GenerateDataQualityRulesRequest": { "description": "Request details for generating data quality rule recommendations.", "id": "GoogleCloudDataplexV1GenerateDataQualityRulesRequest", @@ -12581,11 +13070,11 @@ "additionalProperties": { "type": "string" }, -"description": "Optional. Allows to configure the context.", +"description": "Optional. Allows to configure the context.Supported options: format - The format of the context (one of yaml, xml, json, default is yaml). context_budget - If provided, the output will be intelligently truncated on a best-effort basis to contain approximately the desired amount of characters. There is no guarantee to achieve the specific amount.", "type": "object" }, "resources": { -"description": "Required. The entry names to lookup context for. The request should have max 10 of those.Examples:projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}", +"description": "Required. The entry names to look up the context for. The maximum number of resources for a request is limited to 10.Examples:projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}", "items": { "type": "string" }, @@ -12599,7 +13088,7 @@ "id": "GoogleCloudDataplexV1LookupContextResponse", "properties": { "context": { -"description": "LLM generated context for the resources.", +"description": "Pre-formatted block of text containing the context for the requested resources.", "type": "string" } }, @@ -13105,6 +13594,33 @@ }, "type": "object" }, +"GoogleCloudDataplexV1ModifyEntryRequest": { +"description": "Modify Entry request using permissions in the source system.", +"id": "GoogleCloudDataplexV1ModifyEntryRequest", +"properties": { +"aspectKeys": { +"description": "Optional. The aspect keys which the service should modify. It supports the following syntaxes: - matches an aspect of the given type and empty path. @path - matches an aspect of the given type and specified path. For example, to attach an aspect to a field that is specified by the schema aspect, the path should have the format Schema.. @* - matches aspects of the given type for all paths. *@path - matches aspects of all types on the given path.The service will not remove existing aspects matching the syntax unless delete_missing_aspects is set to true.If this field is left empty, the service treats it as specifying exactly those Aspects present in the request.", +"items": { +"type": "string" +}, +"type": "array" +}, +"deleteMissingAspects": { +"description": "Optional. If set to true, any aspects not specified in the request will be deleted. The default is false.", +"type": "boolean" +}, +"entry": { +"$ref": "GoogleCloudDataplexV1Entry", +"description": "Required. The entry to modify." +}, +"updateMask": { +"description": "Optional. Mask of fields to update. To update Aspects, the update_mask must contain the value \"aspects\".If the update_mask is empty, the service will update all modifiable fields present in the request.", +"format": "google-fieldmask", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDataplexV1OperationMetadata": { "description": "Represents the metadata of a long-running operation.", "id": "GoogleCloudDataplexV1OperationMetadata", diff --git a/googleapiclient/discovery_cache/documents/dataproc.v1.json b/googleapiclient/discovery_cache/documents/dataproc.v1.json index 80e5792d1c..1be8631bf8 100644 --- a/googleapiclient/discovery_cache/documents/dataproc.v1.json +++ b/googleapiclient/discovery_cache/documents/dataproc.v1.json @@ -4,6 +4,12 @@ "scopes": { "https://www.googleapis.com/auth/cloud-platform": { "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." +}, +"https://www.googleapis.com/auth/dataproc": { +"description": "See, edit, configure, and delete your Google Cloud Dataproc data and see the email address for your Google Account" +}, +"https://www.googleapis.com/auth/dataproc.read-only": { +"description": "See your Google Cloud Dataproc data and the email address of your Google Account" } } } @@ -223,7 +229,8 @@ "$ref": "AutoscalingPolicy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc" ] }, "delete": { @@ -248,7 +255,8 @@ "$ref": "Empty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc" ] }, "get": { @@ -273,7 +281,8 @@ "$ref": "AutoscalingPolicy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc" ] }, "getIamPolicy": { @@ -301,7 +310,8 @@ "$ref": "Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc" ] }, "list": { @@ -337,7 +347,8 @@ "$ref": "ListAutoscalingPoliciesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc" ] }, "setIamPolicy": { @@ -365,7 +376,8 @@ "$ref": "Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc" ] }, "testIamPermissions": { @@ -393,7 +405,8 @@ "$ref": "TestIamPermissionsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc" ] }, "update": { @@ -421,7 +434,8 @@ "$ref": "AutoscalingPolicy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc" ] } } @@ -453,7 +467,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc" ] }, "create": { @@ -491,7 +506,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc" ] }, "delete": { @@ -516,7 +532,8 @@ "$ref": "Empty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc" ] }, "get": { @@ -541,7 +558,9 @@ "$ref": "Batch" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc", +"https://www.googleapis.com/auth/dataproc.read-only" ] }, "list": { @@ -587,7 +606,9 @@ "$ref": "ListBatchesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc", +"https://www.googleapis.com/auth/dataproc.read-only" ] } }, @@ -621,7 +642,9 @@ "$ref": "AccessSparkApplicationResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc", +"https://www.googleapis.com/auth/dataproc.read-only" ] }, "accessEnvironmentInfo": { @@ -651,7 +674,9 @@ "$ref": "AccessSparkApplicationEnvironmentInfoResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc", +"https://www.googleapis.com/auth/dataproc.read-only" ] }, "accessJob": { @@ -687,7 +712,9 @@ "$ref": "AccessSparkApplicationJobResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc", +"https://www.googleapis.com/auth/dataproc.read-only" ] }, "accessSqlPlan": { @@ -723,7 +750,9 @@ "$ref": "AccessSparkApplicationSqlSparkPlanGraphResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc", +"https://www.googleapis.com/auth/dataproc.read-only" ] }, "accessSqlQuery": { @@ -769,7 +798,9 @@ "$ref": "AccessSparkApplicationSqlQueryResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc", +"https://www.googleapis.com/auth/dataproc.read-only" ] }, "accessStageAttempt": { @@ -817,7 +848,9 @@ "$ref": "AccessSparkApplicationStageAttemptResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc", +"https://www.googleapis.com/auth/dataproc.read-only" ] }, "accessStageRddGraph": { @@ -853,7 +886,9 @@ "$ref": "AccessSparkApplicationStageRddOperationGraphResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc", +"https://www.googleapis.com/auth/dataproc.read-only" ] }, "search": { @@ -928,7 +963,9 @@ "$ref": "SearchSparkApplicationsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc", +"https://www.googleapis.com/auth/dataproc.read-only" ] }, "searchExecutorStageSummary": { @@ -981,7 +1018,9 @@ "$ref": "SearchSparkApplicationExecutorStageSummaryResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc", +"https://www.googleapis.com/auth/dataproc.read-only" ] }, "searchExecutors": { @@ -1037,7 +1076,9 @@ "$ref": "SearchSparkApplicationExecutorsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc", +"https://www.googleapis.com/auth/dataproc.read-only" ] }, "searchJobs": { @@ -1097,7 +1138,9 @@ "$ref": "SearchSparkApplicationJobsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc", +"https://www.googleapis.com/auth/dataproc.read-only" ] }, "searchSqlQueries": { @@ -1148,7 +1191,9 @@ "$ref": "SearchSparkApplicationSqlQueriesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc", +"https://www.googleapis.com/auth/dataproc.read-only" ] }, "searchStageAttemptTasks": { @@ -1227,7 +1272,9 @@ "$ref": "SearchSparkApplicationStageAttemptTasksResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc", +"https://www.googleapis.com/auth/dataproc.read-only" ] }, "searchStageAttempts": { @@ -1280,7 +1327,9 @@ "$ref": "SearchSparkApplicationStageAttemptsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc", +"https://www.googleapis.com/auth/dataproc.read-only" ] }, "searchStages": { @@ -1348,7 +1397,9 @@ "$ref": "SearchSparkApplicationStagesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc", +"https://www.googleapis.com/auth/dataproc.read-only" ] }, "summarizeExecutors": { @@ -1378,7 +1429,9 @@ "$ref": "SummarizeSparkApplicationExecutorsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc", +"https://www.googleapis.com/auth/dataproc.read-only" ] }, "summarizeJobs": { @@ -1408,7 +1461,9 @@ "$ref": "SummarizeSparkApplicationJobsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc", +"https://www.googleapis.com/auth/dataproc.read-only" ] }, "summarizeStageAttemptTasks": { @@ -1450,7 +1505,9 @@ "$ref": "SummarizeSparkApplicationStageAttemptTasksResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc", +"https://www.googleapis.com/auth/dataproc.read-only" ] }, "summarizeStages": { @@ -1480,7 +1537,9 @@ "$ref": "SummarizeSparkApplicationStagesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc", +"https://www.googleapis.com/auth/dataproc.read-only" ] }, "write": { @@ -1508,7 +1567,8 @@ "$ref": "WriteSparkApplicationContextResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc" ] } } @@ -1539,7 +1599,8 @@ "$ref": "Empty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc" ] }, "delete": { @@ -1564,7 +1625,8 @@ "$ref": "Empty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc" ] }, "get": { @@ -1589,7 +1651,9 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc", +"https://www.googleapis.com/auth/dataproc.read-only" ] }, "list": { @@ -1635,7 +1699,9 @@ "$ref": "ListOperationsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc", +"https://www.googleapis.com/auth/dataproc.read-only" ] } } @@ -1667,7 +1733,8 @@ "$ref": "SessionTemplate" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc" ] }, "delete": { @@ -1692,7 +1759,8 @@ "$ref": "Empty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc" ] }, "get": { @@ -1717,7 +1785,9 @@ "$ref": "SessionTemplate" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc", +"https://www.googleapis.com/auth/dataproc.read-only" ] }, "list": { @@ -1758,7 +1828,9 @@ "$ref": "ListSessionTemplatesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc", +"https://www.googleapis.com/auth/dataproc.read-only" ] }, "patch": { @@ -1786,7 +1858,8 @@ "$ref": "SessionTemplate" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc" ] } } @@ -1828,7 +1901,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc" ] }, "delete": { @@ -1858,7 +1932,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc" ] }, "get": { @@ -1883,7 +1958,9 @@ "$ref": "Session" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc", +"https://www.googleapis.com/auth/dataproc.read-only" ] }, "list": { @@ -1924,7 +2001,9 @@ "$ref": "ListSessionsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc", +"https://www.googleapis.com/auth/dataproc.read-only" ] }, "terminate": { @@ -1952,7 +2031,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc" ] } }, @@ -1986,7 +2066,9 @@ "$ref": "AccessSessionSparkApplicationResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc", +"https://www.googleapis.com/auth/dataproc.read-only" ] }, "accessEnvironmentInfo": { @@ -2016,7 +2098,9 @@ "$ref": "AccessSessionSparkApplicationEnvironmentInfoResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc", +"https://www.googleapis.com/auth/dataproc.read-only" ] }, "accessJob": { @@ -2052,7 +2136,9 @@ "$ref": "AccessSessionSparkApplicationJobResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc", +"https://www.googleapis.com/auth/dataproc.read-only" ] }, "accessSqlPlan": { @@ -2088,7 +2174,9 @@ "$ref": "AccessSessionSparkApplicationSqlSparkPlanGraphResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc", +"https://www.googleapis.com/auth/dataproc.read-only" ] }, "accessSqlQuery": { @@ -2134,7 +2222,9 @@ "$ref": "AccessSessionSparkApplicationSqlQueryResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc", +"https://www.googleapis.com/auth/dataproc.read-only" ] }, "accessStageAttempt": { @@ -2182,7 +2272,9 @@ "$ref": "AccessSessionSparkApplicationStageAttemptResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc", +"https://www.googleapis.com/auth/dataproc.read-only" ] }, "accessStageRddGraph": { @@ -2218,7 +2310,9 @@ "$ref": "AccessSessionSparkApplicationStageRddOperationGraphResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc", +"https://www.googleapis.com/auth/dataproc.read-only" ] }, "search": { @@ -2293,7 +2387,9 @@ "$ref": "SearchSessionSparkApplicationsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc", +"https://www.googleapis.com/auth/dataproc.read-only" ] }, "searchExecutorStageSummary": { @@ -2346,7 +2442,9 @@ "$ref": "SearchSessionSparkApplicationExecutorStageSummaryResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc", +"https://www.googleapis.com/auth/dataproc.read-only" ] }, "searchExecutors": { @@ -2402,7 +2500,9 @@ "$ref": "SearchSessionSparkApplicationExecutorsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc", +"https://www.googleapis.com/auth/dataproc.read-only" ] }, "searchJobs": { @@ -2469,7 +2569,9 @@ "$ref": "SearchSessionSparkApplicationJobsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc", +"https://www.googleapis.com/auth/dataproc.read-only" ] }, "searchSqlQueries": { @@ -2526,7 +2628,9 @@ "$ref": "SearchSessionSparkApplicationSqlQueriesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc", +"https://www.googleapis.com/auth/dataproc.read-only" ] }, "searchStageAttemptTasks": { @@ -2605,7 +2709,9 @@ "$ref": "SearchSessionSparkApplicationStageAttemptTasksResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc", +"https://www.googleapis.com/auth/dataproc.read-only" ] }, "searchStageAttempts": { @@ -2658,7 +2764,9 @@ "$ref": "SearchSessionSparkApplicationStageAttemptsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc", +"https://www.googleapis.com/auth/dataproc.read-only" ] }, "searchStages": { @@ -2733,7 +2841,9 @@ "$ref": "SearchSessionSparkApplicationStagesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc", +"https://www.googleapis.com/auth/dataproc.read-only" ] }, "summarizeExecutors": { @@ -2763,7 +2873,9 @@ "$ref": "SummarizeSessionSparkApplicationExecutorsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc", +"https://www.googleapis.com/auth/dataproc.read-only" ] }, "summarizeJobs": { @@ -2800,7 +2912,9 @@ "$ref": "SummarizeSessionSparkApplicationJobsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc", +"https://www.googleapis.com/auth/dataproc.read-only" ] }, "summarizeStageAttemptTasks": { @@ -2842,7 +2956,9 @@ "$ref": "SummarizeSessionSparkApplicationStageAttemptTasksResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc", +"https://www.googleapis.com/auth/dataproc.read-only" ] }, "summarizeStages": { @@ -2879,7 +2995,9 @@ "$ref": "SummarizeSessionSparkApplicationStagesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc", +"https://www.googleapis.com/auth/dataproc.read-only" ] }, "write": { @@ -2907,7 +3025,8 @@ "$ref": "WriteSessionSparkApplicationContextResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc" ] } } @@ -2941,7 +3060,8 @@ "$ref": "WorkflowTemplate" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc" ] }, "delete": { @@ -2972,7 +3092,8 @@ "$ref": "Empty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc" ] }, "get": { @@ -3003,7 +3124,9 @@ "$ref": "WorkflowTemplate" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc", +"https://www.googleapis.com/auth/dataproc.read-only" ] }, "getIamPolicy": { @@ -3031,7 +3154,8 @@ "$ref": "Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc" ] }, "instantiate": { @@ -3059,7 +3183,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc" ] }, "instantiateInline": { @@ -3092,7 +3217,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc" ] }, "list": { @@ -3128,7 +3254,9 @@ "$ref": "ListWorkflowTemplatesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc", +"https://www.googleapis.com/auth/dataproc.read-only" ] }, "setIamPolicy": { @@ -3156,7 +3284,8 @@ "$ref": "Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc" ] }, "testIamPermissions": { @@ -3184,7 +3313,8 @@ "$ref": "TestIamPermissionsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc" ] }, "update": { @@ -3212,7 +3342,8 @@ "$ref": "WorkflowTemplate" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc" ] } } @@ -3248,7 +3379,8 @@ "$ref": "AutoscalingPolicy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc" ] }, "delete": { @@ -3273,7 +3405,8 @@ "$ref": "Empty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc" ] }, "get": { @@ -3298,7 +3431,8 @@ "$ref": "AutoscalingPolicy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc" ] }, "getIamPolicy": { @@ -3326,7 +3460,8 @@ "$ref": "Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc" ] }, "list": { @@ -3362,7 +3497,8 @@ "$ref": "ListAutoscalingPoliciesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc" ] }, "setIamPolicy": { @@ -3390,7 +3526,8 @@ "$ref": "Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc" ] }, "testIamPermissions": { @@ -3418,7 +3555,8 @@ "$ref": "TestIamPermissionsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc" ] }, "update": { @@ -3446,7 +3584,8 @@ "$ref": "AutoscalingPolicy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc" ] } } @@ -3504,7 +3643,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc" ] }, "delete": { @@ -3558,7 +3698,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc" ] }, "diagnose": { @@ -3599,7 +3740,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc" ] }, "get": { @@ -3637,7 +3779,9 @@ "$ref": "Cluster" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc", +"https://www.googleapis.com/auth/dataproc.read-only" ] }, "getIamPolicy": { @@ -3665,7 +3809,8 @@ "$ref": "Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc" ] }, "injectCredentials": { @@ -3709,7 +3854,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc" ] }, "list": { @@ -3728,13 +3874,13 @@ "type": "string" }, "pageSize": { -"description": "Optional. The standard List page size.", +"description": "Optional. The maximum number of clusters to return in each response. The service may return fewer than this value. If unspecified, the default value is 200. The maximum value is 1000.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "Optional. The standard List page token.", +"description": "Optional. A page token received from a previous ListClusters call. Provide this token to retrieve the subsequent page.", "location": "query", "type": "string" }, @@ -3756,7 +3902,9 @@ "$ref": "ListClustersResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc", +"https://www.googleapis.com/auth/dataproc.read-only" ] }, "patch": { @@ -3814,7 +3962,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc" ] }, "repair": { @@ -3855,7 +4004,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc" ] }, "setIamPolicy": { @@ -3883,7 +4033,8 @@ "$ref": "Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc" ] }, "start": { @@ -3924,7 +4075,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc" ] }, "stop": { @@ -3965,7 +4117,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc" ] }, "testIamPermissions": { @@ -3993,7 +4146,8 @@ "$ref": "TestIamPermissionsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc" ] } }, @@ -4040,7 +4194,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc" ] }, "get": { @@ -4065,7 +4220,9 @@ "$ref": "NodeGroup" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc", +"https://www.googleapis.com/auth/dataproc.read-only" ] }, "repair": { @@ -4093,7 +4250,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc" ] }, "resize": { @@ -4121,7 +4279,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc" ] } } @@ -4168,7 +4327,8 @@ "$ref": "Job" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc" ] }, "delete": { @@ -4206,7 +4366,8 @@ "$ref": "Empty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc" ] }, "get": { @@ -4244,7 +4405,9 @@ "$ref": "Job" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc", +"https://www.googleapis.com/auth/dataproc.read-only" ] }, "getIamPolicy": { @@ -4272,7 +4435,8 @@ "$ref": "Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc" ] }, "list": { @@ -4339,7 +4503,9 @@ "$ref": "ListJobsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc", +"https://www.googleapis.com/auth/dataproc.read-only" ] }, "patch": { @@ -4386,7 +4552,8 @@ "$ref": "Job" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc" ] }, "setIamPolicy": { @@ -4414,7 +4581,8 @@ "$ref": "Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc" ] }, "submit": { @@ -4448,7 +4616,8 @@ "$ref": "Job" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc" ] }, "submitAsOperation": { @@ -4482,7 +4651,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc" ] }, "testIamPermissions": { @@ -4510,7 +4680,8 @@ "$ref": "TestIamPermissionsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc" ] } } @@ -4539,7 +4710,8 @@ "$ref": "Empty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc" ] }, "delete": { @@ -4564,7 +4736,8 @@ "$ref": "Empty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc" ] }, "get": { @@ -4589,7 +4762,9 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc", +"https://www.googleapis.com/auth/dataproc.read-only" ] }, "getIamPolicy": { @@ -4617,7 +4792,8 @@ "$ref": "Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc" ] }, "list": { @@ -4663,7 +4839,9 @@ "$ref": "ListOperationsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc", +"https://www.googleapis.com/auth/dataproc.read-only" ] }, "setIamPolicy": { @@ -4691,7 +4869,8 @@ "$ref": "Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc" ] }, "testIamPermissions": { @@ -4719,7 +4898,8 @@ "$ref": "TestIamPermissionsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc" ] } } @@ -4751,7 +4931,8 @@ "$ref": "WorkflowTemplate" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc" ] }, "delete": { @@ -4782,7 +4963,8 @@ "$ref": "Empty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc" ] }, "get": { @@ -4813,7 +4995,9 @@ "$ref": "WorkflowTemplate" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc", +"https://www.googleapis.com/auth/dataproc.read-only" ] }, "getIamPolicy": { @@ -4841,7 +5025,8 @@ "$ref": "Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc" ] }, "instantiate": { @@ -4869,7 +5054,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc" ] }, "instantiateInline": { @@ -4902,7 +5088,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc" ] }, "list": { @@ -4938,7 +5125,9 @@ "$ref": "ListWorkflowTemplatesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc", +"https://www.googleapis.com/auth/dataproc.read-only" ] }, "setIamPolicy": { @@ -4966,7 +5155,8 @@ "$ref": "Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc" ] }, "testIamPermissions": { @@ -4994,7 +5184,8 @@ "$ref": "TestIamPermissionsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc" ] }, "update": { @@ -5022,7 +5213,8 @@ "$ref": "WorkflowTemplate" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc" ] } } @@ -5032,7 +5224,7 @@ } } }, -"revision": "20260319", +"revision": "20260327", "rootUrl": "https://dataproc.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -6022,6 +6214,20 @@ "$ref": "EndpointConfig", "description": "Optional. Port/endpoint configuration for this cluster" }, +"engine": { +"description": "Optional. The cluster engine.", +"enum": [ +"ENGINE_UNSPECIFIED", +"DEFAULT", +"LIGHTNING" +], +"enumDescriptions": [ +"The engine is not specified. Works the same as ENGINE_DEFAULT.", +"The cluster is a default engine cluster.", +"The cluster is a lightning engine cluster." +], +"type": "string" +}, "gceClusterConfig": { "$ref": "GceClusterConfig", "description": "Optional. The shared Compute Engine config settings for all instances in a cluster." @@ -11179,6 +11385,13 @@ "desc": { "type": "string" }, +"metadata": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Additional metadata for the spark plan graph cluster.", +"type": "object" +}, "metrics": { "items": { "$ref": "SqlPlanMetric" @@ -11223,6 +11436,13 @@ "desc": { "type": "string" }, +"metadata": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Additional metadata for the spark plan graph cluster.", +"type": "object" +}, "metrics": { "items": { "$ref": "SqlPlanMetric" diff --git a/googleapiclient/discovery_cache/documents/displayvideo.v2.json b/googleapiclient/discovery_cache/documents/displayvideo.v2.json index 46574fafee..fd0a99d31f 100644 --- a/googleapiclient/discovery_cache/documents/displayvideo.v2.json +++ b/googleapiclient/discovery_cache/documents/displayvideo.v2.json @@ -7981,7 +7981,7 @@ } } }, -"revision": "20260312", +"revision": "20260331", "rootUrl": "https://displayvideo.googleapis.com/", "schemas": { "ActivateManualTriggerRequest": { @@ -11962,7 +11962,7 @@ false "type": "string" }, "value": { -"description": "Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0.", +"description": "Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPC` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0.", "format": "int64", "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/displayvideo.v3.json b/googleapiclient/discovery_cache/documents/displayvideo.v3.json index 1a2e8464c8..0770c73f56 100644 --- a/googleapiclient/discovery_cache/documents/displayvideo.v3.json +++ b/googleapiclient/discovery_cache/documents/displayvideo.v3.json @@ -8706,7 +8706,7 @@ } } }, -"revision": "20260312", +"revision": "20260331", "rootUrl": "https://displayvideo.googleapis.com/", "schemas": { "ActiveViewVideoViewabilityMetricConfig": { @@ -8965,6 +8965,10 @@ "description": "Output only. Details of a [non-skippable short video ad](//support.google.com/displayvideo/answer/6274216), equal to or less than 6 seconds, used for reach.", "readOnly": true }, +"dcmTrackingInfo": { +"$ref": "DcmTrackingInfo", +"description": "Optional. The DCM tracking ad info. Only valid for Demand Gen ads. To remove the DCM tracking ad info, please leave this field empty. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users." +}, "demandGenCarouselAd": { "$ref": "DemandGenCarouselAd", "description": "Details of a [Demand Gen carousel ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#CarouselAd)." @@ -14715,6 +14719,28 @@ false }, "type": "object" }, +"DcmTrackingInfo": { +"description": "Details on the DCM tracking.", +"id": "DcmTrackingInfo", +"properties": { +"creativeId": { +"description": "Required. The DCM creative id.", +"format": "int64", +"type": "string" +}, +"placementId": { +"description": "Required. The DCM placement id.", +"format": "int64", +"type": "string" +}, +"trackingAdId": { +"description": "Required. The DCM tracking ad id.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, "DeleteAssignedTargetingOptionsRequest": { "description": "A request listing which assigned targeting options of a given targeting type should be deleted.", "id": "DeleteAssignedTargetingOptionsRequest", @@ -14883,7 +14909,7 @@ false "type": "string" }, "value": { -"description": "Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0.", +"description": "Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPC` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0.", "format": "int64", "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/displayvideo.v4.json b/googleapiclient/discovery_cache/documents/displayvideo.v4.json index 0877bb669c..9cdf168597 100644 --- a/googleapiclient/discovery_cache/documents/displayvideo.v4.json +++ b/googleapiclient/discovery_cache/documents/displayvideo.v4.json @@ -9363,7 +9363,7 @@ } } }, -"revision": "20260312", +"revision": "20260331", "rootUrl": "https://displayvideo.googleapis.com/", "schemas": { "ActiveViewVideoViewabilityMetricConfig": { @@ -9678,6 +9678,10 @@ "description": "Output only. Details of a [non-skippable short video ad](//support.google.com/displayvideo/answer/6274216), equal to or less than 6 seconds, used for reach.", "readOnly": true }, +"dcmTrackingInfo": { +"$ref": "DcmTrackingInfo", +"description": "Optional. The DCM tracking ad info. Only valid for Demand Gen ads. To remove the DCM tracking ad info, please leave this field empty. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users." +}, "demandGenCarouselAd": { "$ref": "DemandGenCarouselAd", "description": "Details of a [Demand Gen carousel ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#CarouselAd)." @@ -15470,6 +15474,28 @@ false }, "type": "object" }, +"DcmTrackingInfo": { +"description": "Details on the DCM tracking.", +"id": "DcmTrackingInfo", +"properties": { +"creativeId": { +"description": "Required. The DCM creative id.", +"format": "int64", +"type": "string" +}, +"placementId": { +"description": "Required. The DCM placement id.", +"format": "int64", +"type": "string" +}, +"trackingAdId": { +"description": "Required. The DCM tracking ad id.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, "DeleteAssignedTargetingOptionsRequest": { "description": "A request listing which assigned targeting options of a given targeting type should be deleted.", "id": "DeleteAssignedTargetingOptionsRequest", @@ -15638,7 +15664,7 @@ false "type": "string" }, "value": { -"description": "Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0.", +"description": "Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPC` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0.", "format": "int64", "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/documentai.v1.json b/googleapiclient/discovery_cache/documents/documentai.v1.json index f39f9af4be..eb59ad75ca 100644 --- a/googleapiclient/discovery_cache/documents/documentai.v1.json +++ b/googleapiclient/discovery_cache/documents/documentai.v1.json @@ -231,7 +231,7 @@ ] }, "list": { -"description": "Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.", +"description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "flatPath": "v1/projects/{projectsId}/locations", "httpMethod": "GET", "id": "documentai.projects.locations.list", @@ -1436,7 +1436,7 @@ } } }, -"revision": "20260316", +"revision": "20260325", "rootUrl": "https://documentai.googleapis.com/", "schemas": { "CloudAiDocumentaiLabHifiaToolsValidationValidatorInput": { diff --git a/googleapiclient/discovery_cache/documents/documentai.v1beta3.json b/googleapiclient/discovery_cache/documents/documentai.v1beta3.json index 9c1ba42b43..6b9091b3b1 100644 --- a/googleapiclient/discovery_cache/documents/documentai.v1beta3.json +++ b/googleapiclient/discovery_cache/documents/documentai.v1beta3.json @@ -202,7 +202,7 @@ ] }, "list": { -"description": "Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.", +"description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "flatPath": "v1beta3/projects/{projectsId}/locations", "httpMethod": "GET", "id": "documentai.projects.locations.list", @@ -1678,7 +1678,7 @@ } } }, -"revision": "20260316", +"revision": "20260325", "rootUrl": "https://documentai.googleapis.com/", "schemas": { "CloudAiDocumentaiLabHifiaToolsValidationValidatorInput": { diff --git a/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json b/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json index fc43a83f3b..0f72d587be 100644 --- a/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json +++ b/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json @@ -206,7 +206,7 @@ } } }, -"revision": "20260322", +"revision": "20260405", "rootUrl": "https://firebaseml.googleapis.com/", "schemas": { "Date": { @@ -2155,6 +2155,14 @@ "description": "A RagChunk includes the content of a chunk of a RagFile, and associated metadata.", "id": "GoogleCloudAiplatformV1beta1RagChunk", "properties": { +"chunkId": { +"description": "The ID of the chunk.", +"type": "string" +}, +"fileId": { +"description": "The ID of the file that the chunk belongs to.", +"type": "string" +}, "pageSpan": { "$ref": "GoogleCloudAiplatformV1beta1RagChunkPageSpan", "description": "If populated, represents where the chunk starts and ends in the document." diff --git a/googleapiclient/discovery_cache/documents/firestore.v1.json b/googleapiclient/discovery_cache/documents/firestore.v1.json index c28f29a3b1..dad0f570fb 100644 --- a/googleapiclient/discovery_cache/documents/firestore.v1.json +++ b/googleapiclient/discovery_cache/documents/firestore.v1.json @@ -2435,7 +2435,7 @@ } } }, -"revision": "20260323", +"revision": "20260327", "rootUrl": "https://firestore.googleapis.com/", "schemas": { "Aggregation": { @@ -4183,6 +4183,10 @@ ], "type": "string" }, +"searchIndexOptions": { +"$ref": "GoogleFirestoreAdminV1SearchIndexOptions", +"description": "Optional. Options for search indexes that are at the index definition level. This field is only currently supported for indexes with MONGODB_COMPATIBLE_API ApiScope." +}, "shardCount": { "description": "Optional. The number of shards for the index.", "format": "int32", @@ -4296,6 +4300,10 @@ ], "type": "string" }, +"searchConfig": { +"$ref": "GoogleFirestoreAdminV1SearchConfig", +"description": "Indicates that this field supports search operations. This field is only currently supported for indexes with MONGODB_COMPATIBLE_API ApiScope." +}, "vectorConfig": { "$ref": "GoogleFirestoreAdminV1VectorConfig", "description": "Indicates that this field supports nearest neighbor and distance operations on vector." @@ -4604,6 +4612,136 @@ }, "type": "object" }, +"GoogleFirestoreAdminV1SearchConfig": { +"description": "The configuration for how to index a field for search.", +"id": "GoogleFirestoreAdminV1SearchConfig", +"properties": { +"geoSpec": { +"$ref": "GoogleFirestoreAdminV1SearchGeoSpec", +"description": "Optional. The specification for building a geo search index for a field." +}, +"numberSpec": { +"$ref": "GoogleFirestoreAdminV1SearchNumberSpec", +"description": "Optional. The specification for building a number search index for a field." +}, +"textSpec": { +"$ref": "GoogleFirestoreAdminV1SearchTextSpec", +"description": "Optional. The specification for building a text search index for a field." +} +}, +"type": "object" +}, +"GoogleFirestoreAdminV1SearchGeoSpec": { +"description": "The specification for how to build a geo search index for a field.", +"id": "GoogleFirestoreAdminV1SearchGeoSpec", +"properties": { +"geoJsonIndexingDisabled": { +"description": "Optional. Disables geoJSON indexing for the field. By default, geoJSON points are indexed.", +"type": "boolean" +} +}, +"type": "object" +}, +"GoogleFirestoreAdminV1SearchIndexOptions": { +"description": "Options for search indexes at the definition level.", +"id": "GoogleFirestoreAdminV1SearchIndexOptions", +"properties": { +"customPartitionFieldPaths": { +"description": "Optional. Custom partition fields to use for the search index. If unspecified, all indexed fields will be in the same default partition. If a search index is created specifying custom partition fields, all search queries using that index will be required to filter on the partition. For indexes with MONGODB_COMPATIBLE_API ApiScope: This must refer to a top level field name.", +"items": { +"type": "string" +}, +"type": "array" +}, +"textLanguage": { +"description": "Optional. The language to use for text search indexes. Used as the default language if not overridden at the document level by specifying the `text_language_override_field`. The language is specified as a BCP 47 language code. For indexes with MONGODB_COMPATIBLE_API ApiScope: If unspecified, the default language is English. For indexes with `ANY_API` ApiScope: If unspecified, the default behavior is autodetect.", +"type": "string" +}, +"textLanguageOverrideFieldPath": { +"description": "Optional. The field in the document that specifies which language to use for that specific document. For indexes with MONGODB_COMPATIBLE_API ApiScope: if unspecified, the language is taken from the \"language\" field if it exists or from `text_language` if it does not.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleFirestoreAdminV1SearchNumberSpec": { +"description": "The specification for how to build a number search index for a field.", +"id": "GoogleFirestoreAdminV1SearchNumberSpec", +"properties": { +"indexType": { +"description": "Required. How to index the number field value.", +"enum": [ +"NUMBER_INDEX_TYPE_UNSPECIFIED", +"FLOAT64", +"INT32_LOG_TREE", +"INT64_LOG_TREE", +"INT32_PREFIX_TREE", +"INT64_PREFIX_TREE" +], +"enumDescriptions": [ +"The index type is unspecified. Not a valid option.", +"A floating point index.", +"A log tree index for int32 values.", +"A log tree index for int64 values.", +"A prefix tree index for int32 values.", +"A prefix tree index for int64 values." +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleFirestoreAdminV1SearchTextIndexSpec": { +"description": "Specification of how the field should be indexed for search text indexes.", +"id": "GoogleFirestoreAdminV1SearchTextIndexSpec", +"properties": { +"indexType": { +"description": "Required. How to index the text field value.", +"enum": [ +"TEXT_INDEX_TYPE_UNSPECIFIED", +"TOKENIZED", +"NGRAMS", +"EXACT_MATCH" +], +"enumDescriptions": [ +"The index type is unspecified. Not a valid option.", +"Field values are tokenized. This is the only way currently supported for MONGODB_COMPATIBLE_API.", +"Field values are indexed as n-grams.", +"Field values are indexed to allow fast equality checks." +], +"type": "string" +}, +"matchType": { +"description": "Required. How to match the text field value.", +"enum": [ +"TEXT_MATCH_TYPE_UNSPECIFIED", +"MATCH_GLOBALLY", +"MATCH_FIELD" +], +"enumDescriptions": [ +"The match type is unspecified. Not a valid option.", +"Match on any indexed field. This is the only way currently supported for MONGODB_COMPATIBLE_API.", +"Match on a specific field." +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleFirestoreAdminV1SearchTextSpec": { +"description": "The specification for how to build a text search index for a field.", +"id": "GoogleFirestoreAdminV1SearchTextSpec", +"properties": { +"indexSpecs": { +"description": "Required. Specifications for how the field should be indexed. Repeated so that the field can be indexed in multiple ways.", +"items": { +"$ref": "GoogleFirestoreAdminV1SearchTextIndexSpec" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleFirestoreAdminV1SourceEncryptionOptions": { "description": "The configuration options for using the same encryption method as the source.", "id": "GoogleFirestoreAdminV1SourceEncryptionOptions", @@ -4651,9 +4789,14 @@ "type": "object" }, "GoogleFirestoreAdminV1TtlConfig": { -"description": "The TTL (time-to-live) configuration for documents that have this `Field` set. Storing a timestamp value into a TTL-enabled field will be treated as the document's absolute expiration time. For Enterprise edition databases, the timestamp value may also be stored in an array value in the TTL-enabled field. Timestamp values in the past indicate that the document is eligible for immediate expiration. Using any other data type or leaving the field absent will disable expiration for the individual document.", +"description": "The TTL (time-to-live) configuration for documents that have this `Field` set. A timestamp stored in a TTL-enabled field will be used to determine the expiration time of the document. The expiration time is the sum of the timestamp value and the `expiration_offset`. For Enterprise edition databases, the timestamp value may alternatively be stored in an array value in the TTL-enabled field. An expiration time in the past indicates that the document is eligible for immediate expiration. Using any other data type or leaving the field absent will disable expiration for the individual document.", "id": "GoogleFirestoreAdminV1TtlConfig", "properties": { +"expirationOffset": { +"description": "Optional. The offset, relative to the timestamp value from the TTL-enabled field, used to determine the document's expiration time. `expiration_offset.seconds` must be between 0 and 2,147,483,647 inclusive. Values more precise than seconds are rejected. If unset, defaults to 0, in which case the expiration time is the same as the timestamp value from the TTL-enabled field.", +"format": "google-duration", +"type": "string" +}, "state": { "description": "Output only. The state of the TTL configuration.", "enum": [ @@ -4691,6 +4834,11 @@ "The TTL config is being removed." ], "type": "string" +}, +"expirationOffset": { +"description": "The offset, relative to the timestamp value in the TTL-enabled field, used determine the document's expiration time.", +"format": "google-duration", +"type": "string" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/gkebackup.v1.json b/googleapiclient/discovery_cache/documents/gkebackup.v1.json index 6e1495392a..993c764e3e 100644 --- a/googleapiclient/discovery_cache/documents/gkebackup.v1.json +++ b/googleapiclient/discovery_cache/documents/gkebackup.v1.json @@ -135,7 +135,7 @@ ] }, "list": { -"description": "Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.", +"description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "flatPath": "v1/projects/{projectsId}/locations", "httpMethod": "GET", "id": "gkebackup.projects.locations.list", @@ -2338,7 +2338,7 @@ } } }, -"revision": "20260213", +"revision": "20260318", "rootUrl": "https://gkebackup.googleapis.com/", "schemas": { "AuditConfig": { @@ -2475,7 +2475,7 @@ "type": "object" }, "BDRBackupRestoreJobLog": { -"description": "Log entry for Backup and Restore Job for resources using BackupPlan based protection. Next Id: 23", +"description": "Log entry for Backup and Restore Job for resources using BackupPlan based protection. Next Id: 24", "id": "BDRBackupRestoreJobLog", "properties": { "backupConsistencyTime": { @@ -2504,6 +2504,10 @@ "description": "Full resource name backup vault name", "type": "string" }, +"dataSourceName": { +"description": "Canonical Data Source Name", +"type": "string" +}, "endTime": { "description": "End time of the job.", "format": "google-datetime", diff --git a/googleapiclient/discovery_cache/documents/gkeonprem.v1.json b/googleapiclient/discovery_cache/documents/gkeonprem.v1.json index fde8ab71b1..5424a80368 100644 --- a/googleapiclient/discovery_cache/documents/gkeonprem.v1.json +++ b/googleapiclient/discovery_cache/documents/gkeonprem.v1.json @@ -135,7 +135,7 @@ ] }, "list": { -"description": "Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.", +"description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "flatPath": "v1/projects/{projectsId}/locations", "httpMethod": "GET", "id": "gkeonprem.projects.locations.list", @@ -3163,7 +3163,7 @@ } } }, -"revision": "20260225", +"revision": "20260325", "rootUrl": "https://gkeonprem.googleapis.com/", "schemas": { "Authorization": { diff --git a/googleapiclient/discovery_cache/documents/health.v4.json b/googleapiclient/discovery_cache/documents/health.v4.json new file mode 100644 index 0000000000..f3a3dfaf21 --- /dev/null +++ b/googleapiclient/discovery_cache/documents/health.v4.json @@ -0,0 +1,3531 @@ +{ +"basePath": "", +"baseUrl": "https://health.googleapis.com/", +"batchPath": "batch", +"canonicalName": "Google Health API", +"description": "The Google Health API lets you view and manage health and fitness metrics and measurement data.", +"discoveryVersion": "v1", +"documentationLink": "https://developers.google.com/health", +"fullyEncodeReservedExpansion": true, +"icons": { +"x16": "http://www.google.com/images/icons/product/search-16.gif", +"x32": "http://www.google.com/images/icons/product/search-32.gif" +}, +"id": "health:v4", +"kind": "discovery#restDescription", +"mtlsRootUrl": "https://health.mtls.googleapis.com/", +"name": "health", +"ownerDomain": "google.com", +"ownerName": "Google", +"parameters": { +"$.xgafv": { +"description": "V1 error format.", +"enum": [ +"1", +"2" +], +"enumDescriptions": [ +"v1 error format", +"v2 error format" +], +"location": "query", +"type": "string" +}, +"access_token": { +"description": "OAuth access token.", +"location": "query", +"type": "string" +}, +"alt": { +"default": "json", +"description": "Data format for response.", +"enum": [ +"json", +"media", +"proto" +], +"enumDescriptions": [ +"Responses with Content-Type of application/json", +"Media download with context-dependent Content-Type", +"Responses with Content-Type of application/x-protobuf" +], +"location": "query", +"type": "string" +}, +"callback": { +"description": "JSONP", +"location": "query", +"type": "string" +}, +"fields": { +"description": "Selector specifying which fields to include in a partial response.", +"location": "query", +"type": "string" +}, +"key": { +"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", +"location": "query", +"type": "string" +}, +"oauth_token": { +"description": "OAuth 2.0 token for the current user.", +"location": "query", +"type": "string" +}, +"prettyPrint": { +"default": "true", +"description": "Returns response with indentations and line breaks.", +"location": "query", +"type": "boolean" +}, +"quotaUser": { +"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", +"location": "query", +"type": "string" +}, +"uploadType": { +"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", +"location": "query", +"type": "string" +}, +"upload_protocol": { +"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", +"location": "query", +"type": "string" +} +}, +"protocol": "rest", +"resources": { +"users": { +"methods": { +"getIdentity": { +"description": "Gets the user's identity. It includes the legacy Fitbit user ID and the Google user ID and it can be used by migrating clients to map identifiers between the two systems.", +"flatPath": "v4/users/{usersId}/identity", +"httpMethod": "GET", +"id": "health.users.getIdentity", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the Identity. Format: `users/me/identity`", +"location": "path", +"pattern": "^users/[^/]+/identity$", +"required": true, +"type": "string" +} +}, +"path": "v4/{+name}", +"response": { +"$ref": "Identity" +} +}, +"getProfile": { +"description": "Returns user Profile details.", +"flatPath": "v4/users/{usersId}/profile", +"httpMethod": "GET", +"id": "health.users.getProfile", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the Profile. Format: `users/me/profile`.", +"location": "path", +"pattern": "^users/[^/]+/profile$", +"required": true, +"type": "string" +} +}, +"path": "v4/{+name}", +"response": { +"$ref": "Profile" +} +}, +"getSettings": { +"description": "Returns user settings details.", +"flatPath": "v4/users/{usersId}/settings", +"httpMethod": "GET", +"id": "health.users.getSettings", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the Settings. Format: `users/me/settings`.", +"location": "path", +"pattern": "^users/[^/]+/settings$", +"required": true, +"type": "string" +} +}, +"path": "v4/{+name}", +"response": { +"$ref": "Settings" +} +}, +"updateProfile": { +"description": "Updates the user's profile details.", +"flatPath": "v4/users/{usersId}/profile", +"httpMethod": "PATCH", +"id": "health.users.updateProfile", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Identifier. The resource name of this Profile resource. Format: `users/{user}/profile` Example: `users/1234567890/profile` or `users/me/profile` The {user} ID is a system-generated Google Health API user ID, a string of 1-63 characters consisting of lowercase and uppercase letters, numbers, and hyphens. The literal `me` can also be used to refer to the authenticated user.", +"location": "path", +"pattern": "^users/[^/]+/profile$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Optional. The list of fields to be updated.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v4/{+name}", +"request": { +"$ref": "Profile" +}, +"response": { +"$ref": "Profile" +} +}, +"updateSettings": { +"description": "Updates the user's settings details.", +"flatPath": "v4/users/{usersId}/settings", +"httpMethod": "PATCH", +"id": "health.users.updateSettings", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Identifier. The resource name of this Settings resource. Format: `users/{user}/settings` Example: `users/1234567890/settings` or `users/me/settings` The {user} ID is a system-generated Google Health API user ID, a string of 1-63 characters consisting of lowercase and uppercase letters, numbers, and hyphens. The literal `me` can also be used to refer to the authenticated user.", +"location": "path", +"pattern": "^users/[^/]+/settings$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Optional. The list of fields to be updated.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v4/{+name}", +"request": { +"$ref": "Settings" +}, +"response": { +"$ref": "Settings" +} +} +}, +"resources": { +"dataTypes": { +"resources": { +"dataPoints": { +"methods": { +"batchDelete": { +"description": "Delete a batch of identifyable data points.", +"flatPath": "v4/users/{usersId}/dataTypes/{dataTypesId}/dataPoints:batchDelete", +"httpMethod": "POST", +"id": "health.users.dataTypes.dataPoints.batchDelete", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Optional. Parent (data type) for the Data Point collection Format: `users/me/dataTypes/{data_type}`, e.g.: - `users/me/dataTypes/steps` - `users/me/dataTypes/-` For a list of the supported data types see the DataPoint data union field. Deleting data points across multiple data type collections is supported following https://aip.dev/159. If this is set, the parent of all of the data points specified in `names` must match this field.", +"location": "path", +"pattern": "^users/[^/]+/dataTypes/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/{+parent}/dataPoints:batchDelete", +"request": { +"$ref": "BatchDeleteDataPointsRequest" +}, +"response": { +"$ref": "Operation" +} +}, +"create": { +"description": "Creates a single identifiable data point.", +"flatPath": "v4/users/{usersId}/dataTypes/{dataTypesId}/dataPoints", +"httpMethod": "POST", +"id": "health.users.dataTypes.dataPoints.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The parent resource name where the data point will be created. Format: `users/{user}/dataTypes/{data_type}`", +"location": "path", +"pattern": "^users/[^/]+/dataTypes/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/{+parent}/dataPoints", +"request": { +"$ref": "DataPoint" +}, +"response": { +"$ref": "Operation" +} +}, +"dailyRollUp": { +"description": "Roll up data points over civil time intervals for supported data types.", +"flatPath": "v4/users/{usersId}/dataTypes/{dataTypesId}/dataPoints:dailyRollUp", +"httpMethod": "POST", +"id": "health.users.dataTypes.dataPoints.dailyRollUp", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. Parent data type of the Data Point collection. Format: `users/{user}/dataTypes/{data_type}`, e.g.: - `users/me/dataTypes/steps` - `users/me/dataTypes/distance` For a list of the supported data types see the DailyRollupDataPoint value union field.", +"location": "path", +"pattern": "^users/[^/]+/dataTypes/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/{+parent}/dataPoints:dailyRollUp", +"request": { +"$ref": "DailyRollUpDataPointsRequest" +}, +"response": { +"$ref": "DailyRollUpDataPointsResponse" +} +}, +"exportExerciseTcx": { +"description": "Exports exercise data in TCX format. Note: While the Authorization section below states that any one of the listed scopes is accepted, this specific method requires the user to provide both one of the `activity_and_fitness` scopes (`normal` or `readonly`) AND one of the `location` scopes (`normal` or `readonly`) in their access token to succeed.", +"flatPath": "v4/users/{usersId}/dataTypes/{dataTypesId}/dataPoints/{dataPointsId}:exportExerciseTcx", +"httpMethod": "GET", +"id": "health.users.dataTypes.dataPoints.exportExerciseTcx", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the exercise data point to export. Format: `users/{user}/dataTypes/exercise/dataPoints/{data_point}` Example: `users/me/dataTypes/exercise/dataPoints/2026443605080188808` The `{user}` is the alias `\"me\"` currently. Future versions may support user IDs. The `{data_point}` ID maps to the exercise ID, which is a long integer.", +"location": "path", +"pattern": "^users/[^/]+/dataTypes/[^/]+/dataPoints/[^/]+$", +"required": true, +"type": "string" +}, +"partialData": { +"description": "Optional. Indicates whether to include the TCX data points when the GPS data is not available. If not specified, defaults to `false` and partial data will not be included.", +"location": "query", +"type": "boolean" +} +}, +"path": "v4/{+name}:exportExerciseTcx", +"response": { +"$ref": "ExportExerciseTcxResponse" +}, +"supportsMediaDownload": true, +"useMediaDownloadService": true +}, +"list": { +"description": "Query user health and fitness data points.", +"flatPath": "v4/users/{usersId}/dataTypes/{dataTypesId}/dataPoints", +"httpMethod": "GET", +"id": "health.users.dataTypes.dataPoints.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. Filter expression following https://google.aip.dev/160. A time range (either physical or civil) can be specified. The supported filter fields are: - Interval start time: - Pattern: `{interval_data_type}.interval.start_time` - Supported comparison operators: `>=`, `<` - Timestamp literal expected in RFC-3339 format - Supported logical operators: `AND` - Example: - `steps.interval.start_time >= \"2023-11-24T00:00:00Z\" AND steps.interval.start_time < \"2023-11-25T00:00:00Z\"` - `distance.interval.start_time >= \"2024-08-14T12:34:56Z\"` - Interval civil start time: - Pattern: `{interval_data_type}.interval.civil_start_time` - Supported comparison operators: `>=`, `<` - Date with optional time literal expected in ISO 8601 `YYYY-MM-DD[THH:mm:ss]` format - Supported logical operators: `AND` - Example: - `steps.interval.civil_start_time >= \"2023-11-24\" AND steps.interval.civil_start_time < \"2023-11-25\"` - `distance.interval.civil_start_time >= \"2024-08-14T12:34:56\"` - Sample observation physical time: - Pattern: `{sample_data_type}.sample_time.physical_time` - Supported comparison operators: `>=`, `<` - Timestamp literal expected in RFC-3339 format - Supported logical operators: `AND` - Example: - `weight.sample_time.physical_time >= \"2023-11-24T00:00:00Z\" AND weight.sample_time.physical_time < \"2023-11-25T00:00:00Z\"` - `weight.sample_time.physical_time >= \"2024-08-14T12:34:56Z\"` - Sample observation civil time: - Pattern: `{sample_data_type}.sample_time.civil_time` - Supported comparison operators: `>=`, `<` - Date with optional time literal expected in ISO 8601 `YYYY-MM-DD[THH:mm:ss]` format - Supported logical operators: `AND` - Example: - `weight.sample_time.civil_time >= \"2023-11-24\" AND weight.sample_time.civil_time < \"2023-11-25\"` - `weight.sample_time.civil_time >= \"2024-08-14T12:34:56\"` - Daily summary date: - Pattern: `{daily_summary_data_type}.date` - Supported comparison operators: `>=`, `<` - Date literal expected in ISO 8601 `YYYY-MM-DD` format - Supported logical operators: `AND` - Example: - `daily_resting_heart_rate.date >= \"2024-08-14\"` - `daily_heart_rate_variability.date < \"2024-08-15\"` - Session civil start time (**Excluding Sleep**): - Pattern: `{session_data_type}.interval.civil_start_time` - Supported comparison operators: `>=`, `<` - Date with optional time literal expected in ISO 8601 `YYYY-MM-DD[THH:mm:ss]` format - Supported logical operators: `AND` - Example: - `exercise.interval.civil_start_time >= \"2023-11-24\" AND exercise.interval.civil_start_time < \"2023-11-25\"` - `exercise.interval.civil_start_time >= \"2024-08-14T12:34:56\"` - Session end time (**Sleep specific**): - Pattern: `sleep.interval.end_time` - Supported comparison operators: `>=`, `<` - Timestamp literal expected in RFC-3339 format - Supported logical operators: `AND`, `OR` - Example: - `sleep.interval.end_time >= \"2023-11-24T00:00:00Z\" AND sleep.interval.end_time < \"2023-11-25T00:00:00Z\"` - Session civil end time (**Sleep specific**): - Pattern: `sleep.interval.civil_end_time` - Supported comparison operators: `>=`, `<` - Date with optional time literal expected in ISO 8601 `YYYY-MM-DD[THH:mm:ss]` format - Supported logical operators: `AND`, `OR` - Example: - `sleep.interval.civil_end_time >= \"2023-11-24\" AND sleep.interval.civil_end_time < \"2023-11-25\"` Data points in the response will be ordered by the interval start time in descending order.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. The maximum number of data points to return. If unspecified, at most 1440 data points will be returned. The maximum page size is 10000; values above that will be truncated accordingly. For `exercise` and `sleep` the default page size is 25. The maximum page size for `exercise` and `sleep` is 25.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. The `next_page_token` from a previous request, if any.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. Parent data type of the Data Point collection. Format: `users/me/dataTypes/{data_type}`, e.g.: - `users/me/dataTypes/steps` - `users/me/dataTypes/weight` For a list of the supported data types see the DataPoint data union field.", +"location": "path", +"pattern": "^users/[^/]+/dataTypes/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/{+parent}/dataPoints", +"response": { +"$ref": "ListDataPointsResponse" +} +}, +"patch": { +"description": "Updates a single identifiable data point. If a data point with the specified `name` is not found, the request will fail.", +"flatPath": "v4/users/{usersId}/dataTypes/{dataTypesId}/dataPoints/{dataPointsId}", +"httpMethod": "PATCH", +"id": "health.users.dataTypes.dataPoints.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Identifier. Data point name, only supported for the subset of identifiable data types. For the majority of the data types, individual data points do not need to be identified and this field would be empty. Format: `users/{user}/dataTypes/{data_type}/dataPoints/{data_point}` Example: `users/abcd1234/dataTypes/sleep/dataPoints/a1b2c3d4-e5f6-7890-1234-567890abcdef` The `{user}` ID is a system-generated identifier, as described in Identity.health_user_id. The `{data_type}` ID corresponds to the kebab-case version of the field names in the DataPoint data union field, e.g. `total-calories` for the `total_calories` field. The `{data_point}` ID can be client-provided or system-generated. If client-provided, it must be a string of 4-63 characters, containing only lowercase letters, numbers, and hyphens.", +"location": "path", +"pattern": "^users/[^/]+/dataTypes/[^/]+/dataPoints/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/{+name}", +"request": { +"$ref": "DataPoint" +}, +"response": { +"$ref": "Operation" +} +}, +"reconcile": { +"description": "Reconcile data points from multiple data sources into a single data stream.", +"flatPath": "v4/users/{usersId}/dataTypes/{dataTypesId}/dataPoints:reconcile", +"httpMethod": "GET", +"id": "health.users.dataTypes.dataPoints.reconcile", +"parameterOrder": [ +"parent" +], +"parameters": { +"dataSourceFamily": { +"description": "Optional. The data source family name to reconcile. If empty, data points from all data sources will be reconciled. Format: `users/me/dataSourceFamilies/{data_source_family}` The supported values are: - `users/me/dataSourceFamilies/all-sources` - default value - `users/me/dataSourceFamilies/google-wearables` - tracker devices - `users/me/dataSourceFamilies/google-sources` - Google first party sources", +"location": "query", +"type": "string" +}, +"filter": { +"description": "Optional. Filter expression based on https://aip.dev/160. A time range, either physical or civil, can be specified. See the ListDataPointsRequest.filter for the supported fields and syntax.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. The maximum number of data points to return. If unspecified, at most 1440 data points will be returned. The maximum page size is 10000; values above that will be truncated accordingly. For `exercise` and `sleep` the default page size is 25. The maximum page size for `exercise` and `sleep` is 25.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. The `next_page_token` from a previous request, if any.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. Parent data type of the Data Point collection. Format: `users/me/dataTypes/{data_type}`, e.g.: - `users/me/dataTypes/steps` - `users/me/dataTypes/heart-rate` For a list of the supported data types see the DataPoint data union field.", +"location": "path", +"pattern": "^users/[^/]+/dataTypes/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/{+parent}/dataPoints:reconcile", +"response": { +"$ref": "ReconcileDataPointsResponse" +} +}, +"rollUp": { +"description": "Roll up data points over physical time intervals for supported data types.", +"flatPath": "v4/users/{usersId}/dataTypes/{dataTypesId}/dataPoints:rollUp", +"httpMethod": "POST", +"id": "health.users.dataTypes.dataPoints.rollUp", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. Parent data type of the Data Point collection. Format: `users/{user}/dataTypes/{data_type}`, e.g.: - `users/me/dataTypes/steps` - `users/me/dataTypes/distance` For a list of the supported data types see the RollupDataPoint value union field.", +"location": "path", +"pattern": "^users/[^/]+/dataTypes/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/{+parent}/dataPoints:rollUp", +"request": { +"$ref": "RollUpDataPointsRequest" +}, +"response": { +"$ref": "RollUpDataPointsResponse" +} +} +} +} +} +} +} +} +}, +"revision": "20260405", +"rootUrl": "https://health.googleapis.com/", +"schemas": { +"ActiveMinutes": { +"description": "Record of active minutes in a given time interval.", +"id": "ActiveMinutes", +"properties": { +"activeMinutesByActivityLevel": { +"description": "Required. Active minutes by activity level. At most one record per activity level is allowed.", +"items": { +"$ref": "ActiveMinutesByActivityLevel" +}, +"type": "array" +}, +"interval": { +"$ref": "ObservationTimeInterval", +"description": "Required. Observed interval." +} +}, +"type": "object" +}, +"ActiveMinutesByActivityLevel": { +"description": "Active minutes at a given activity level.", +"id": "ActiveMinutesByActivityLevel", +"properties": { +"activeMinutes": { +"description": "Required. Number of whole minutes spent in activity.", +"format": "int64", +"type": "string" +}, +"activityLevel": { +"description": "Required. The level of activity.", +"enum": [ +"ACTIVITY_LEVEL_UNSPECIFIED", +"LIGHT", +"MODERATE", +"VIGOROUS" +], +"enumDescriptions": [ +"Activity level is unspecified.", +"Light activity level.", +"Moderate activity level.", +"Vigorous activity level." +], +"type": "string" +} +}, +"type": "object" +}, +"ActiveMinutesRollupByActivityLevel": { +"description": "Active minutes by activity level.", +"id": "ActiveMinutesRollupByActivityLevel", +"properties": { +"activeMinutesSum": { +"description": "Number of whole minutes spent in activity.", +"format": "int64", +"type": "string" +}, +"activityLevel": { +"description": "The level of activity.", +"enum": [ +"ACTIVITY_LEVEL_UNSPECIFIED", +"LIGHT", +"MODERATE", +"VIGOROUS" +], +"enumDescriptions": [ +"Activity level is unspecified.", +"Light activity level.", +"Moderate activity level.", +"Vigorous activity level." +], +"type": "string" +} +}, +"type": "object" +}, +"ActiveMinutesRollupValue": { +"description": "Represents the result of the rollup of the active minutes data type.", +"id": "ActiveMinutesRollupValue", +"properties": { +"activeMinutesRollupByActivityLevel": { +"description": "Active minutes by activity level. At most one record per activity level is allowed.", +"items": { +"$ref": "ActiveMinutesRollupByActivityLevel" +}, +"type": "array" +} +}, +"type": "object" +}, +"ActiveZoneMinutes": { +"description": "Record of active zone minutes in a given time interval.", +"id": "ActiveZoneMinutes", +"properties": { +"activeZoneMinutes": { +"description": "Required. Number of Active Zone Minutes earned in the given time interval. Note: active_zone_minutes equals to 1 for low intensity (fat burn) zones or 2 for high intensity zones (cardio, peak).", +"format": "int64", +"type": "string" +}, +"heartRateZone": { +"description": "Required. Heart rate zone in which the active zone minutes have been earned, in the given time interval.", +"enum": [ +"HEART_RATE_ZONE_UNSPECIFIED", +"FAT_BURN", +"CARDIO", +"PEAK" +], +"enumDescriptions": [ +"Unspecified heart rate zone.", +"The fat burn heart rate zone.", +"The cardio heart rate zone.", +"The peak heart rate zone." +], +"type": "string" +}, +"interval": { +"$ref": "ObservationTimeInterval", +"description": "Required. Observed interval." +} +}, +"type": "object" +}, +"ActiveZoneMinutesRollupValue": { +"description": "Represents the result of the rollup of the active zone minutes data type.", +"id": "ActiveZoneMinutesRollupValue", +"properties": { +"sumInCardioHeartZone": { +"description": "Active zone minutes in `HeartRateZone.CARDIO`.", +"format": "int64", +"type": "string" +}, +"sumInFatBurnHeartZone": { +"description": "Active zone minutes in `HeartRateZone.FAT_BURN`.", +"format": "int64", +"type": "string" +}, +"sumInPeakHeartZone": { +"description": "Active zone minutes in `HeartRateZone.PEAK`.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"ActivityLevel": { +"description": "Internal type to capture activity level during a certain time interval.", +"id": "ActivityLevel", +"properties": { +"activityLevelType": { +"description": "Required. Activity level type in the given time interval.", +"enum": [ +"ACTIVITY_LEVEL_TYPE_UNSPECIFIED", +"SEDENTARY", +"LIGHTLY_ACTIVE", +"MODERATELY_ACTIVE", +"VERY_ACTIVE" +], +"enumDescriptions": [ +"Unspecified activity level type.", +"Sedentary activity level.", +"Lightly active activity level.", +"Moderately active activity level.", +"Very active activity level." +], +"type": "string" +}, +"interval": { +"$ref": "ObservationTimeInterval", +"description": "Required. Observed interval." +} +}, +"type": "object" +}, +"ActivityLevelRollupByActivityLevelType": { +"description": "Represents the total duration in a specific activity level type.", +"id": "ActivityLevelRollupByActivityLevelType", +"properties": { +"activityLevelType": { +"description": "Activity level type.", +"enum": [ +"ACTIVITY_LEVEL_TYPE_UNSPECIFIED", +"SEDENTARY", +"LIGHTLY_ACTIVE", +"MODERATELY_ACTIVE", +"VERY_ACTIVE" +], +"enumDescriptions": [ +"Unspecified activity level type.", +"Sedentary activity level.", +"Lightly active activity level.", +"Moderately active activity level.", +"Very active activity level." +], +"type": "string" +}, +"totalDuration": { +"description": "Total duration in the activity level type.", +"format": "google-duration", +"type": "string" +} +}, +"type": "object" +}, +"ActivityLevelRollupValue": { +"description": "Represents the result of the rollup of the activity level data type.", +"id": "ActivityLevelRollupValue", +"properties": { +"activityLevelRollupsByActivityLevelType": { +"description": "List of total durations in each activity level type.", +"items": { +"$ref": "ActivityLevelRollupByActivityLevelType" +}, +"type": "array" +} +}, +"type": "object" +}, +"Altitude": { +"description": "Captures the altitude gain (i.e. deltas), and not level above sea, for a user in millimeters.", +"id": "Altitude", +"properties": { +"gainMillimeters": { +"description": "Required. Altitude gain in millimeters over the observed interval.", +"format": "int64", +"type": "string" +}, +"interval": { +"$ref": "ObservationTimeInterval", +"description": "Required. Observed interval." +} +}, +"type": "object" +}, +"AltitudeRollupValue": { +"description": "Represents the result of the rollup of the user's altitude.", +"id": "AltitudeRollupValue", +"properties": { +"gainMillimetersSum": { +"description": "Sum of the altitude gain in millimeters.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"Application": { +"description": "Optional metadata for the application that provided this data.", +"id": "Application", +"properties": { +"googleWebClientId": { +"description": "Output only. The Google OAuth 2.0 client ID of the web application or service that recorded the data. This is the client ID used during the Google OAuth flow to obtain user credentials. This field is system-populated when the data is uploaded from Google Web API.", +"readOnly": true, +"type": "string" +}, +"packageName": { +"description": "Output only. A unique identifier for the mobile application that was the source of the data. This is typically the application's package name on Android (e.g., `com.google.fitbit`) or the bundle ID on iOS. This field is informational and helps trace data origin. This field is system-populated when the data is uploaded from the Fitbit mobile application, Health Connect or Health Kit.", +"readOnly": true, +"type": "string" +}, +"webClientId": { +"description": "Output only. The client ID of the application that recorded the data. This ID is a legacy Fitbit API client ID, which is different from a Google OAuth client ID. Example format: `ABC123`. This field is system-populated and used for tracing data from legacy Fitbit API integrations. This field is system-populated when the data is uploaded from a legacy Fitbit API integration.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"BatchDeleteDataPointsRequest": { +"description": "Request to delete a batch of identifiable data points.", +"id": "BatchDeleteDataPointsRequest", +"properties": { +"names": { +"description": "Required. The names of the DataPoints to delete. A maximum of 10000 data points can be deleted in a single request.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"BodyFat": { +"description": "Body fat measurement.", +"id": "BodyFat", +"properties": { +"percentage": { +"description": "Required. Body fat percentage, in range [0, 100].", +"format": "double", +"type": "number" +}, +"sampleTime": { +"$ref": "ObservationSampleTime", +"description": "Required. The time at which body fat was measured." +} +}, +"type": "object" +}, +"BodyFatRollupValue": { +"description": "Represents the result of the rollup of the body fat data type.", +"id": "BodyFatRollupValue", +"properties": { +"bodyFatPercentageAvg": { +"description": "Average body fat percentage.", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, +"CaloriesInHeartRateZoneRollupValue": { +"description": "Represents the result of the rollup of the calories in heart rate zone data type.", +"id": "CaloriesInHeartRateZoneRollupValue", +"properties": { +"caloriesInHeartRateZones": { +"description": "List of calories burned in each heart rate zone.", +"items": { +"$ref": "CaloriesInHeartRateZoneValue" +}, +"type": "array" +} +}, +"type": "object" +}, +"CaloriesInHeartRateZoneValue": { +"description": "Represents the amount of kilocalories burned in a specific heart rate zone.", +"id": "CaloriesInHeartRateZoneValue", +"properties": { +"heartRateZone": { +"description": "The heart rate zone.", +"enum": [ +"HEART_RATE_ZONE_TYPE_UNSPECIFIED", +"LIGHT", +"MODERATE", +"VIGOROUS", +"PEAK" +], +"enumDescriptions": [ +"Unspecified heart rate zone.", +"The light heart rate zone.", +"The moderate heart rate zone.", +"The vigorous heart rate zone.", +"The peak heart rate zone." +], +"type": "string" +}, +"kcal": { +"description": "The amount of kilocalories burned in the specified heart rate zone.", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, +"CivilDateTime": { +"description": "Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries.", +"id": "CivilDateTime", +"properties": { +"date": { +"$ref": "Date", +"description": "Required. Calendar date." +}, +"time": { +"$ref": "TimeOfDay", +"description": "Optional. Time of day. Defaults to the start of the day, at midnight if omitted." +} +}, +"type": "object" +}, +"CivilTimeInterval": { +"description": "Counterpart of google.type.Interval, but using CivilDateTime.", +"id": "CivilTimeInterval", +"properties": { +"end": { +"$ref": "CivilDateTime", +"description": "Required. The exclusive end of the range." +}, +"start": { +"$ref": "CivilDateTime", +"description": "Required. The inclusive start of the range." +} +}, +"type": "object" +}, +"DailyHeartRateVariability": { +"description": "Represents the daily heart rate variability data type. At least one of the following fields must be set: - `average_heart_rate_variability_milliseconds` - `non_rem_heart_rate_beats_per_minute` - `entropy` - `deep_sleep_root_mean_square_of_successive_differences_milliseconds`", +"id": "DailyHeartRateVariability", +"properties": { +"averageHeartRateVariabilityMilliseconds": { +"description": "Optional. A user's average heart rate variability calculated using the root mean square of successive differences (RMSSD) in times between heartbeats.", +"format": "double", +"type": "number" +}, +"date": { +"$ref": "Date", +"description": "Required. Date (in the user's timezone) of heart rate variability measurement." +}, +"deepSleepRootMeanSquareOfSuccessiveDifferencesMilliseconds": { +"description": "Optional. The root mean square of successive differences (RMSSD) value during deep sleep.", +"format": "double", +"type": "number" +}, +"entropy": { +"description": "Optional. The Shanon entropy of heartbeat intervals. Entropy quantifies randomness or disorder in a system. High entropy indicates high HRV. Entropy is measured from the histogram of time interval between successive heart beats values measured during sleep.", +"format": "double", +"type": "number" +}, +"nonRemHeartRateBeatsPerMinute": { +"description": "Optional. Non-REM heart rate", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"DailyHeartRateZones": { +"description": "User's heart rate zone thresholds based on the Karvonen algorithm for a specific day.", +"id": "DailyHeartRateZones", +"properties": { +"date": { +"$ref": "Date", +"description": "Required. Date (in user's timezone) of the heart rate zones record." +}, +"heartRateZones": { +"description": "Required. The heart rate zones.", +"items": { +"$ref": "HeartRateZone" +}, +"type": "array" +} +}, +"type": "object" +}, +"DailyOxygenSaturation": { +"description": "A daily oxygen saturation (SpO2) record. Represents the user's daily oxygen saturation summary, typically calculated during sleep.", +"id": "DailyOxygenSaturation", +"properties": { +"averagePercentage": { +"description": "Required. The average value of the oxygen saturation samples during the sleep.", +"format": "double", +"type": "number" +}, +"date": { +"$ref": "Date", +"description": "Required. Date (in user's timezone) of the daily oxygen saturation record." +}, +"lowerBoundPercentage": { +"description": "Required. The lower bound of the confidence interval of oxygen saturation samples during sleep.", +"format": "double", +"type": "number" +}, +"standardDeviationPercentage": { +"description": "Optional. Standard deviation of the daily oxygen saturation averages from the past 7-30 days.", +"format": "double", +"type": "number" +}, +"upperBoundPercentage": { +"description": "Required. The upper bound of the confidence interval of oxygen saturation samples during sleep.", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, +"DailyRespiratoryRate": { +"description": "A daily average respiratory rate (breaths per minute) for a day of the year. One data point per day calculated for the main sleep.", +"id": "DailyRespiratoryRate", +"properties": { +"breathsPerMinute": { +"description": "Required. The average number of breaths taken per minute.", +"format": "double", +"type": "number" +}, +"date": { +"$ref": "Date", +"description": "Required. The date on which the respiratory rate was measured." +} +}, +"type": "object" +}, +"DailyRestingHeartRate": { +"description": "Measures the daily resting heart rate for a user, calculated using the all day heart rate measurements.", +"id": "DailyRestingHeartRate", +"properties": { +"beatsPerMinute": { +"description": "Required. The resting heart rate value in beats per minute.", +"format": "int64", +"type": "string" +}, +"dailyRestingHeartRateMetadata": { +"$ref": "DailyRestingHeartRateMetadata", +"description": "Optional. Metadata for the daily resting heart rate." +}, +"date": { +"$ref": "Date", +"description": "Required. Date (in the user's timezone) of the resting heart rate measurement." +} +}, +"type": "object" +}, +"DailyRestingHeartRateMetadata": { +"description": "Metadata for the daily resting heart rate.", +"id": "DailyRestingHeartRateMetadata", +"properties": { +"calculationMethod": { +"description": "Required. The method used to calculate the resting heart rate.", +"enum": [ +"CALCULATION_METHOD_UNSPECIFIED", +"WITH_SLEEP", +"ONLY_WITH_AWAKE_DATA" +], +"enumDescriptions": [ +"The calculation method is unspecified.", +"The resting heart rate is calculated using the sleep data.", +"The resting heart rate is calculated using only awake data." +], +"type": "string" +} +}, +"type": "object" +}, +"DailyRollUpDataPointsRequest": { +"description": "Request to roll up data points by civil time intervals.", +"id": "DailyRollUpDataPointsRequest", +"properties": { +"dataSourceFamily": { +"description": "Optional. The data source family name to roll up. If empty, data points from all available data sources will be rolled up. Format: `users/me/dataSourceFamilies/{data_source_family}` The supported values are: - `users/me/dataSourceFamilies/all-sources` - default value - `users/me/dataSourceFamilies/google-wearables` - tracker devices - `users/me/dataSourceFamilies/google-sources` - Google first party sources", +"type": "string" +}, +"pageSize": { +"description": "Optional. The maximum number of data points to return. If unspecified, at most 1440 data points will be returned. The maximum page size is 10000; values above that will be truncated accordingly.", +"format": "int32", +"type": "integer" +}, +"pageToken": { +"description": "Optional. The `next_page_token` from a previous request, if any. All other request fields need to be the same as in the initial request when the page token is specified.", +"type": "string" +}, +"range": { +"$ref": "CivilTimeInterval", +"description": "Required. Closed-open range of data points that will be rolled up. The start time must be aligned with the aggregation window. The maximum range for `calories-in-heart-rate-zone`, `heart-rate`, `active-minutes` and `total-calories` is 14 days. The maximum range for all other data types is 90 days." +}, +"windowSizeDays": { +"description": "Optional. Aggregation window size, in number of days. Defaults to 1 if not specified.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"DailyRollUpDataPointsResponse": { +"description": "Response containing the list of rolled up data points.", +"id": "DailyRollUpDataPointsResponse", +"properties": { +"rollupDataPoints": { +"description": "Values for each aggregation time window.", +"items": { +"$ref": "DailyRollupDataPoint" +}, +"type": "array" +} +}, +"type": "object" +}, +"DailyRollupDataPoint": { +"description": "Value of a daily rollup for a single civil time interval (aggregation window)", +"id": "DailyRollupDataPoint", +"properties": { +"activeMinutes": { +"$ref": "ActiveMinutesRollupValue", +"description": "Returned by default when rolling up data points from the `active-minutes` data type, or when requested explicitly using the `active-minutes` rollup type identifier." +}, +"activeZoneMinutes": { +"$ref": "ActiveZoneMinutesRollupValue", +"description": "Returned by default when rolling up data points from the `active-zone-minutes` data type, or when requested explicitly using the `active-zone-minutes` rollup type identifier." +}, +"activityLevel": { +"$ref": "ActivityLevelRollupValue", +"description": "Returned by default when rolling up data points from the `activity-level` data type, or when requested explicitly using the `activity-level` rollup type identifier." +}, +"altitude": { +"$ref": "AltitudeRollupValue", +"description": "Returned by default when rolling up data points from the `altitude` data type, or when requested explicitly using the `altitude` rollup type identifier." +}, +"bodyFat": { +"$ref": "BodyFatRollupValue", +"description": "Returned by default when rolling up data points from the `body-fat` data type, or when requested explicitly using the `body-fat` rollup type identifier." +}, +"caloriesInHeartRateZone": { +"$ref": "CaloriesInHeartRateZoneRollupValue", +"description": "Returned by default when rolling up data points from the `calories-in-heart-rate-zone` data type, or when requested explicitly using the `calories-in-heart-rate-zone` rollup type identifier." +}, +"civilEndTime": { +"$ref": "CivilDateTime", +"description": "End time of the window this value aggregates over" +}, +"civilStartTime": { +"$ref": "CivilDateTime", +"description": "Start time of the window this value aggregates over" +}, +"distance": { +"$ref": "DistanceRollupValue", +"description": "Returned by default when rolling up data points from the `distance` data type, or when requested explicitly using the `distance` rollup type identifier." +}, +"floors": { +"$ref": "FloorsRollupValue", +"description": "Returned by default when rolling up data points from the `floors` data type, or when requested explicitly using the `floors` rollup type identifier." +}, +"heartRate": { +"$ref": "HeartRateRollupValue", +"description": "Returned by default when rolling up data points from the `heart-rate` data type, or when requested explicitly using the `heart-rate` rollup type identifier." +}, +"heartRateVariabilityPersonalRange": { +"$ref": "HeartRateVariabilityPersonalRangeRollupValue", +"description": "Returned by default when rolling up data points from the `daily-heart-rate-variability` data type, or when requested explicitly using the `heart-rate-variability-personal-range` rollup type identifier." +}, +"hydrationLog": { +"$ref": "HydrationLogRollupValue", +"description": "Returned by default when rolling up data points from the `hydration-log` data type, or when requested explicitly using the `hydration-log` rollup type identifier." +}, +"restingHeartRatePersonalRange": { +"$ref": "RestingHeartRatePersonalRangeRollupValue", +"description": "Returned by default when rolling up data points from the `daily-resting-heart-rate` data type, or when requested explicitly using the `resting-heart-rate-personal-range` rollup type identifier." +}, +"runVo2Max": { +"$ref": "RunVO2MaxRollupValue", +"description": "Returned by default when rolling up data points from the `run-vo2-max` data type, or when requested explicitly using the `run-vo2-max` rollup type identifier." +}, +"sedentaryPeriod": { +"$ref": "SedentaryPeriodRollupValue", +"description": "Returned by default when rolling up data points from the `sedentary-period` data type, or when requested explicitly using the `sedentary-period` rollup type identifier." +}, +"steps": { +"$ref": "StepsRollupValue", +"description": "Returned by default when rolling up data points from the `steps` data type, or when requested explicitly using the `steps` rollup type identifier." +}, +"timeInHeartRateZone": { +"$ref": "TimeInHeartRateZoneRollupValue", +"description": "Returned by default when rolling up data points from the `time-in-heart-rate-zone` data type, or when requested explicitly using the `time-in-heart-rate-zone` rollup type identifier." +}, +"totalCalories": { +"$ref": "TotalCaloriesRollupValue", +"description": "Returned by default when rolling up data points from the `total-calories` data type, or when requested explicitly using the `total-calories` rollup type identifier." +}, +"weight": { +"$ref": "WeightRollupValue", +"description": "Returned by default when rolling up data points from the `weight` data type, or when requested explicitly using the `weight` rollup type identifier." +} +}, +"type": "object" +}, +"DailySleepTemperatureDerivations": { +"description": "Provides derived sleep temperature values, calculated from skin or internal device temperature readings during sleep.", +"id": "DailySleepTemperatureDerivations", +"properties": { +"baselineTemperatureCelsius": { +"description": "Optional. The user's baseline skin temperature. It is the median of the user's nightly skin temperature over the past 30 days.", +"format": "double", +"type": "number" +}, +"date": { +"$ref": "Date", +"description": "Required. Date for which the sleep temperature derivations are calculated." +}, +"nightlyTemperatureCelsius": { +"description": "Required. The user's nightly skin temperature. It is the mean of skin temperature samples taken from the user\u2019s sleep.", +"format": "double", +"type": "number" +}, +"relativeNightlyStddev30dCelsius": { +"description": "Optional. The standard deviation of the user\u2019s relative nightly skin temperature (temperature - baseline) over the past 30 days.", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, +"DailyVO2Max": { +"description": "Contains a daily summary of the user's VO2 max (cardio fitness score), which is the maximum rate of oxygen the body can use during exercise.", +"id": "DailyVO2Max", +"properties": { +"cardioFitnessLevel": { +"description": "Optional. Represents the user's cardio fitness level based on their VO2 max.", +"enum": [ +"CARDIO_FITNESS_LEVEL_UNSPECIFIED", +"POOR", +"FAIR", +"AVERAGE", +"GOOD", +"VERY_GOOD", +"EXCELLENT" +], +"enumDescriptions": [ +"Unspecified cardio fitness level.", +"Poor cardio fitness level.", +"Fair cardio fitness level.", +"Average cardio fitness level.", +"Good cardio fitness level.", +"Very good cardio fitness level.", +"Excellent cardio fitness level." +], +"type": "string" +}, +"date": { +"$ref": "Date", +"description": "Required. The date for which the Daily VO2 max was measured." +}, +"estimated": { +"description": "Optional. An estimated field is added to indicate when the confidence has decreased sufficiently to consider the value an estimation.", +"type": "boolean" +}, +"vo2Max": { +"description": "Required. Daily VO2 max value measured as in ml consumed oxygen / kg of body weight / min.", +"format": "double", +"type": "number" +}, +"vo2MaxCovariance": { +"description": "Optional. The covariance of the VO2 max value.", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, +"DataPoint": { +"description": "A computed or recorded metric.", +"id": "DataPoint", +"properties": { +"activeMinutes": { +"$ref": "ActiveMinutes", +"description": "Optional. Data for points in the `active-minutes` interval data type collection." +}, +"activeZoneMinutes": { +"$ref": "ActiveZoneMinutes", +"description": "Optional. Data for points in the `active-zone-minutes` interval data type collection, measured in minutes." +}, +"activityLevel": { +"$ref": "ActivityLevel", +"description": "Optional. Data for points in the `activity-level` daily data type collection." +}, +"altitude": { +"$ref": "Altitude", +"description": "Optional. Data for points in the `altitude` interval data type collection." +}, +"bodyFat": { +"$ref": "BodyFat", +"description": "Optional. Data for points in the `body-fat` sample data type collection." +}, +"dailyHeartRateVariability": { +"$ref": "DailyHeartRateVariability", +"description": "Optional. Data for points in the `daily-heart-rate-variability` daily data type collection." +}, +"dailyHeartRateZones": { +"$ref": "DailyHeartRateZones", +"description": "Optional. Data for points in the `daily-heart-rate-zones` daily data type collection." +}, +"dailyOxygenSaturation": { +"$ref": "DailyOxygenSaturation", +"description": "Optional. Data for points in the `daily-oxygen-saturation` daily data type collection." +}, +"dailyRespiratoryRate": { +"$ref": "DailyRespiratoryRate", +"description": "Optional. Data for points in the `daily-respiratory-rate` daily data type collection." +}, +"dailyRestingHeartRate": { +"$ref": "DailyRestingHeartRate", +"description": "Optional. Data for points in the `daily-resting-heart-rate` daily data type collection." +}, +"dailySleepTemperatureDerivations": { +"$ref": "DailySleepTemperatureDerivations", +"description": "Optional. Data for points in the `daily-sleep-temperature-derivations` daily data type collection." +}, +"dailyVo2Max": { +"$ref": "DailyVO2Max", +"description": "Optional. Data for points in the `daily-vo2-max` daily data type collection." +}, +"dataSource": { +"$ref": "DataSource", +"description": "Optional. Data source information for the metric" +}, +"distance": { +"$ref": "Distance", +"description": "Optional. Data for points in the `distance` interval data type collection." +}, +"exercise": { +"$ref": "Exercise", +"description": "Optional. Data for points in the `exercise` session data type collection." +}, +"floors": { +"$ref": "Floors", +"description": "Optional. Data for points in the `floors` interval data type collection." +}, +"heartRate": { +"$ref": "HeartRate", +"description": "Optional. Data for points in the `heart-rate` sample data type collection." +}, +"heartRateVariability": { +"$ref": "HeartRateVariability", +"description": "Optional. Data for points in the `heart-rate-variability` sample data type collection." +}, +"hydrationLog": { +"$ref": "HydrationLog", +"description": "Optional. Data for points in the `hydration-log` session data type collection." +}, +"name": { +"description": "Identifier. Data point name, only supported for the subset of identifiable data types. For the majority of the data types, individual data points do not need to be identified and this field would be empty. Format: `users/{user}/dataTypes/{data_type}/dataPoints/{data_point}` Example: `users/abcd1234/dataTypes/sleep/dataPoints/a1b2c3d4-e5f6-7890-1234-567890abcdef` The `{user}` ID is a system-generated identifier, as described in Identity.health_user_id. The `{data_type}` ID corresponds to the kebab-case version of the field names in the DataPoint data union field, e.g. `total-calories` for the `total_calories` field. The `{data_point}` ID can be client-provided or system-generated. If client-provided, it must be a string of 4-63 characters, containing only lowercase letters, numbers, and hyphens.", +"type": "string" +}, +"oxygenSaturation": { +"$ref": "OxygenSaturation", +"description": "Optional. Data for points in the `oxygen-saturation` sample data type collection." +}, +"respiratoryRateSleepSummary": { +"$ref": "RespiratoryRateSleepSummary", +"description": "Optional. Data for points in the `respiratory-rate-sleep-summary` sample data type collection." +}, +"runVo2Max": { +"$ref": "RunVO2Max", +"description": "Optional. Data for points in the `run-vo2-max` sample data type collection." +}, +"sedentaryPeriod": { +"$ref": "SedentaryPeriod", +"description": "Optional. Data for points in the `sedentary-period` interval data type collection." +}, +"sleep": { +"$ref": "Sleep", +"description": "Optional. Data for points in the `sleep` session data type collection." +}, +"steps": { +"$ref": "Steps", +"description": "Optional. Data for points in the `steps` interval data type collection." +}, +"timeInHeartRateZone": { +"$ref": "TimeInHeartRateZone", +"description": "Optional. Data for points in the `time-in-heart-rate-zone` interval data type collection." +}, +"vo2Max": { +"$ref": "VO2Max", +"description": "Optional. Data for points in the `vo2-max` sample data type collection." +}, +"weight": { +"$ref": "Weight", +"description": "Optional. Data for points in the `weight` sample data type collection." +} +}, +"type": "object" +}, +"DataSource": { +"description": "Data Source definition to track the origin of data. Each health data point, regardless of the complexity or data model (whether a simple step count or a detailed sleep session) must retain information about its source of origin (e.g. the device or app that collected it).", +"id": "DataSource", +"properties": { +"application": { +"$ref": "Application", +"description": "Output only. Captures metadata for the application that provided this data.", +"readOnly": true +}, +"device": { +"$ref": "Device", +"description": "Optional. Captures metadata for raw data points originating from devices. We expect this data source to be used for data points written on device sync." +}, +"platform": { +"description": "Output only. Captures the platform that uploaded the data.", +"enum": [ +"PLATFORM_UNSPECIFIED", +"FITBIT", +"HEALTH_CONNECT", +"HEALTH_KIT", +"FIT", +"FITBIT_WEB_API", +"NEST", +"GOOGLE_WEB_API", +"GOOGLE_PARTNER_INTEGRATION" +], +"enumDescriptions": [ +"The platform is unspecified.", +"The data was uploaded from Fitbit.", +"The data was uploaded from Health Connect.", +"The data was uploaded from Health Kit.", +"The data was uploaded from Google Fit.", +"The data was uploaded from Fitbit legacy Web API.", +"The data was uploaded from Nest devices.", +"The data was uploaded from Google Health API.", +"The data was uploaded from Google Partner Integrations." +], +"readOnly": true, +"type": "string" +}, +"recordingMethod": { +"description": "Optional. Captures how the data was recorded.", +"enum": [ +"RECORDING_METHOD_UNSPECIFIED", +"MANUAL", +"PASSIVELY_MEASURED", +"DERIVED", +"ACTIVELY_MEASURED", +"UNKNOWN" +], +"enumDescriptions": [ +"The recording method is unspecified.", +"The data was manually entered by the user.", +"The data was passively measured by a device.", +"The data was derived from other data, e.g., by an algorithm in the backend.", +"The data was actively measured by a device.", +"The recording method is unknown. This is set when the data is uploaded from a third party app that does not provide this information." +], +"type": "string" +} +}, +"type": "object" +}, +"Date": { +"description": "Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp", +"id": "Date", +"properties": { +"day": { +"description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.", +"format": "int32", +"type": "integer" +}, +"month": { +"description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.", +"format": "int32", +"type": "integer" +}, +"year": { +"description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"DateTime": { +"description": "Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively. This type may also be used to represent a physical time if all the date and time fields are set and either case of the `time_offset` oneof is set. Consider using `Timestamp` message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application's limitations.", +"id": "DateTime", +"properties": { +"day": { +"description": "Optional. Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a datetime without a day.", +"format": "int32", +"type": "integer" +}, +"hours": { +"description": "Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults to 0 (midnight). An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.", +"format": "int32", +"type": "integer" +}, +"minutes": { +"description": "Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0.", +"format": "int32", +"type": "integer" +}, +"month": { +"description": "Optional. Month of year. Must be from 1 to 12, or 0 if specifying a datetime without a month.", +"format": "int32", +"type": "integer" +}, +"nanos": { +"description": "Optional. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999, defaults to 0.", +"format": "int32", +"type": "integer" +}, +"seconds": { +"description": "Optional. Seconds of minutes of the time. Must normally be from 0 to 59, defaults to 0. An API may allow the value 60 if it allows leap-seconds.", +"format": "int32", +"type": "integer" +}, +"timeZone": { +"$ref": "TimeZone", +"description": "Time zone." +}, +"utcOffset": { +"description": "UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }.", +"format": "google-duration", +"type": "string" +}, +"year": { +"description": "Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"Device": { +"description": "Captures metadata about the device that recorded the measurement.", +"id": "Device", +"properties": { +"displayName": { +"description": "Optional. An optional name for the device.", +"type": "string" +}, +"formFactor": { +"description": "Optional. Captures the form factor of the device.", +"enum": [ +"FORM_FACTOR_UNSPECIFIED", +"FITNESS_BAND", +"WATCH", +"PHONE", +"RING", +"CHEST_STRAP", +"SCALE", +"TABLET", +"HEAD_MOUNTED", +"SMART_DISPLAY" +], +"enumDescriptions": [ +"The form factor is unspecified.", +"The device is a fitness band.", +"The device is a watch.", +"The device is a phone.", +"The device is a ring.", +"The device is a chest strap.", +"The device is a scale.", +"The device is a tablet.", +"The device is a head mounted device.", +"The device is a smart display." +], +"type": "string" +}, +"manufacturer": { +"description": "Optional. An optional manufacturer of the device.", +"type": "string" +} +}, +"type": "object" +}, +"Distance": { +"description": "Distance traveled over an interval of time.", +"id": "Distance", +"properties": { +"interval": { +"$ref": "ObservationTimeInterval", +"description": "Required. Observed interval." +}, +"millimeters": { +"description": "Required. Distance in millimeters over the observed interval.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"DistanceRollupValue": { +"description": "Result of the rollup of the user's distance.", +"id": "DistanceRollupValue", +"properties": { +"millimetersSum": { +"description": "Sum of the distance in millimeters.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"Exercise": { +"description": "An exercise that stores information about a physical activity.", +"id": "Exercise", +"properties": { +"activeDuration": { +"description": "Optional. Duration excluding pauses.", +"format": "google-duration", +"type": "string" +}, +"createTime": { +"description": "Output only. Represents the timestamp of the creation of the exercise.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"displayName": { +"description": "Required. Exercise display name.", +"type": "string" +}, +"exerciseEvents": { +"description": "Optional. Exercise events that happen during an exercise, such as pause & restarts.", +"items": { +"$ref": "ExerciseEvent" +}, +"type": "array" +}, +"exerciseMetadata": { +"$ref": "ExerciseMetadata", +"description": "Optional. Additional exercise metadata." +}, +"exerciseType": { +"description": "Required. The type of activity performed during an exercise.", +"enum": [ +"EXERCISE_TYPE_UNSPECIFIED", +"RUNNING", +"WALKING", +"BIKING", +"SWIMMING", +"HIKING", +"YOGA", +"PILATES", +"WORKOUT", +"HIIT", +"WEIGHTLIFTING", +"STRENGTH_TRAINING", +"OTHER" +], +"enumDescriptions": [ +"Exercise type is unspecified.", +"Running type.", +"Walking type.", +"Biking type.", +"Swimming type.", +"Hiking type.", +"Yoga type.", +"Pilates type.", +"Workout type.", +"HIIT type.", +"Weightlifting type.", +"Strength training type.", +"Other type." +], +"type": "string" +}, +"interval": { +"$ref": "SessionTimeInterval", +"description": "Required. Observed exercise interval" +}, +"metricsSummary": { +"$ref": "MetricsSummary", +"description": "Required. Summary metrics for this exercise ( )" +}, +"notes": { +"description": "Optional. Standard free-form notes captured at manual logging.", +"type": "string" +}, +"splitSummaries": { +"description": "Optional. Laps or splits recorded within an exercise. Laps could be split based on distance or other criteria (duration, etc.) Laps should not be overlapping with each other.", +"items": { +"$ref": "SplitSummary" +}, +"type": "array" +}, +"splits": { +"description": "Optional. The default split is 1 km or 1 mile. - if the movement distance is less than the default, then there are no splits - if the movement distance is greater than or equal to the default, then we have splits", +"items": { +"$ref": "SplitSummary" +}, +"type": "array" +}, +"updateTime": { +"description": "Output only. This is the timestamp of the last update to the exercise.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"ExerciseEvent": { +"description": "Represents instantaneous events that happen during an exercise, such as start, stop, pause, split.", +"id": "ExerciseEvent", +"properties": { +"eventTime": { +"description": "Required. Exercise event time", +"format": "google-datetime", +"type": "string" +}, +"eventUtcOffset": { +"description": "Required. Exercise event time offset from UTC", +"format": "google-duration", +"type": "string" +}, +"exerciseEventType": { +"description": "Required. The type of the event, such as start, stop, pause, resume.", +"enum": [ +"EXERCISE_EVENT_TYPE_UNSPECIFIED", +"START", +"STOP", +"PAUSE", +"RESUME", +"AUTO_PAUSE", +"AUTO_RESUME" +], +"enumDescriptions": [ +"Exercise event type is unspecified.", +"Exercise start event.", +"Exercise stop event.", +"Exercise pause event.", +"Exercise resume event.", +"Exercise auto-pause event.", +"Exercise auto-resume event." +], +"type": "string" +} +}, +"type": "object" +}, +"ExerciseMetadata": { +"description": "Additional exercise metadata.", +"id": "ExerciseMetadata", +"properties": { +"hasGps": { +"description": "Optional. Whether the exercise had GPS tracking.", +"type": "boolean" +}, +"poolLengthMillimeters": { +"description": "Optional. Pool length in millimeters. Only present in the swimming exercises.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"ExportExerciseTcxResponse": { +"description": "Represents a Response for exporting exercise data in TCX format.", +"id": "ExportExerciseTcxResponse", +"properties": { +"tcxData": { +"description": "Contains the exported TCX data.", +"type": "string" +} +}, +"type": "object" +}, +"Floors": { +"description": "Gained elevation measured in floors over the time interval", +"id": "Floors", +"properties": { +"count": { +"description": "Required. Number of floors in the recorded interval", +"format": "int64", +"type": "string" +}, +"interval": { +"$ref": "ObservationTimeInterval", +"description": "Required. Observed interval" +} +}, +"type": "object" +}, +"FloorsRollupValue": { +"description": "Represents the result of the rollup of the user's floors.", +"id": "FloorsRollupValue", +"properties": { +"countSum": { +"description": "Sum of the floors count.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"GoogleDevicesandservicesHealthV4DataType": { +"description": "Represents a type of health data a user can have data points recorded for. It matches the parent resource of collection containing data points of the given type. Clients currently do not need to interact with this resource directly.", +"id": "GoogleDevicesandservicesHealthV4DataType", +"properties": { +"name": { +"description": "Identifier. The resource name of the data type. Format: `users/{user}/dataTypes/{data_type}` See DataPoint.name for examples and possible values.", +"type": "string" +} +}, +"type": "object" +}, +"HeartRate": { +"description": "A heart rate measurement.", +"id": "HeartRate", +"properties": { +"beatsPerMinute": { +"description": "Required. The heart rate value in beats per minute.", +"format": "int64", +"type": "string" +}, +"metadata": { +"$ref": "HeartRateMetadata", +"description": "Optional. Metadata about the heart rate sample." +}, +"sampleTime": { +"$ref": "ObservationSampleTime", +"description": "Required. Observation time" +} +}, +"type": "object" +}, +"HeartRateMetadata": { +"description": "Heart rate metadata.", +"id": "HeartRateMetadata", +"properties": { +"motionContext": { +"description": "Optional. Indicates the user\u2019s level of activity when the heart rate sample was measured", +"enum": [ +"MOTION_CONTEXT_UNSPECIFIED", +"ACTIVE", +"SEDENTARY" +], +"enumDescriptions": [ +"The default value when no data is available.", +"The user is active.", +"The user is inactive." +], +"type": "string" +}, +"sensorLocation": { +"description": "Optional. Indicates the location of the sensor that measured the heart rate.", +"enum": [ +"SENSOR_LOCATION_UNSPECIFIED", +"CHEST", +"WRIST", +"FINGER", +"HAND", +"EAR_LOBE", +"FOOT" +], +"enumDescriptions": [ +"The default value when no data is available.", +"Chest sensor.", +"Wrist sensor.", +"Finger sensor.", +"Hand sensor.", +"Ear lobe sensor.", +"Foot sensor." +], +"type": "string" +} +}, +"type": "object" +}, +"HeartRateRollupValue": { +"description": "Represents the result of the rollup of the heart rate data type.", +"id": "HeartRateRollupValue", +"properties": { +"beatsPerMinuteAvg": { +"description": "The average heart rate value in the interval.", +"format": "double", +"type": "number" +}, +"beatsPerMinuteMax": { +"description": "The maximum heart rate value in the interval.", +"format": "double", +"type": "number" +}, +"beatsPerMinuteMin": { +"description": "The minimum heart rate value in the interval.", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, +"HeartRateVariability": { +"description": "Captures user's heart rate variability (HRV) as measured by the root mean square of successive differences (RMSSD) between normal heartbeats or by standard deviation of the inter-beat intervals (SDNN).", +"id": "HeartRateVariability", +"properties": { +"rootMeanSquareOfSuccessiveDifferencesMilliseconds": { +"description": "Optional. The root mean square of successive differences between normal heartbeats. This is a measure of heart rate variability used by Fitbit.", +"format": "double", +"type": "number" +}, +"sampleTime": { +"$ref": "ObservationSampleTime", +"description": "Required. The time of the heart rate variability measurement." +}, +"standardDeviationMilliseconds": { +"description": "Optional. The standard deviation of the heart rate variability measurement.", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, +"HeartRateVariabilityPersonalRangeRollupValue": { +"description": "Represents the result of the rollup of the user's daily heart rate variability personal range.", +"id": "HeartRateVariabilityPersonalRangeRollupValue", +"properties": { +"averageHeartRateVariabilityMillisecondsMax": { +"description": "The upper bound of the user's average heart rate variability personal range.", +"format": "double", +"type": "number" +}, +"averageHeartRateVariabilityMillisecondsMin": { +"description": "The lower bound of the user's average heart rate variability personal range.", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, +"HeartRateZone": { +"description": "The heart rate zone.", +"id": "HeartRateZone", +"properties": { +"heartRateZoneType": { +"description": "Required. The heart rate zone type.", +"enum": [ +"HEART_RATE_ZONE_TYPE_UNSPECIFIED", +"LIGHT", +"MODERATE", +"VIGOROUS", +"PEAK" +], +"enumDescriptions": [ +"Unspecified heart rate zone.", +"The light heart rate zone.", +"The moderate heart rate zone.", +"The vigorous heart rate zone.", +"The peak heart rate zone." +], +"type": "string" +}, +"maxBeatsPerMinute": { +"description": "Required. Maximum heart rate for this zone in beats per minute.", +"format": "int64", +"type": "string" +}, +"minBeatsPerMinute": { +"description": "Required. Minimum heart rate for this zone in beats per minute.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"HydrationLog": { +"description": "Holds information about a user logged hydration.", +"id": "HydrationLog", +"properties": { +"amountConsumed": { +"$ref": "VolumeQuantity", +"description": "Required. Amount of liquid (ex. water) consumed." +}, +"interval": { +"$ref": "SessionTimeInterval", +"description": "Required. Observed interval." +} +}, +"type": "object" +}, +"HydrationLogRollupValue": { +"description": "Represents the result of the rollup of the hydration log data type.", +"id": "HydrationLogRollupValue", +"properties": { +"amountConsumed": { +"$ref": "VolumeQuantityRollup", +"description": "Rollup for amount consumed." +} +}, +"type": "object" +}, +"Identity": { +"description": "Represents details about the Google user's identity.", +"id": "Identity", +"properties": { +"healthUserId": { +"description": "Output only. The Google User Identifier in the Google Health APIs. It matches the `{user}` resource ID segment in the resource name paths, e.g. `users/{user}/dataTypes/steps`. Valid values are strings of 1-63 characters, and valid characters are lowercase and uppercase letters, numbers, and hyphens.", +"readOnly": true, +"type": "string" +}, +"legacyUserId": { +"description": "Output only. The legacy Fitbit User identifier. This is the Fitbit ID used in the legacy Fitbit APIs (v1-v3). It can be referenced by clients migrating from the legacy Fitbit APIs to map their existing identifiers to the new Google user ID. It **must not** be used for any other purpose. It is not of any use for new clients using only the Google Health APIs. Valid values are strings of 1-63 characters, and valid characters are lowercase and uppercase letters, numbers, and hyphens.", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Identifier. The resource name of this Identity resource. Format: `users/me/identity`", +"type": "string" +} +}, +"type": "object" +}, +"Interval": { +"description": "Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time.", +"id": "Interval", +"properties": { +"endTime": { +"description": "Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.", +"format": "google-datetime", +"type": "string" +}, +"startTime": { +"description": "Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"ListDataPointsResponse": { +"description": "Response containing raw data points matching the query", +"id": "ListDataPointsResponse", +"properties": { +"dataPoints": { +"description": "Data points matching the query", +"items": { +"$ref": "DataPoint" +}, +"type": "array" +}, +"nextPageToken": { +"description": "Next page token, empty if the response is complete", +"type": "string" +} +}, +"type": "object" +}, +"MetricsSummary": { +"description": "Summary metrics for an exercise.", +"id": "MetricsSummary", +"properties": { +"activeZoneMinutes": { +"description": "Optional. Total active zone minutes for the exercise.", +"format": "int64", +"type": "string" +}, +"averageHeartRateBeatsPerMinute": { +"description": "Optional. Average heart rate during the exercise.", +"format": "int64", +"type": "string" +}, +"averagePaceSecondsPerMeter": { +"description": "Optional. Average pace in seconds per meter.", +"format": "double", +"type": "number" +}, +"averageSpeedMillimetersPerSecond": { +"description": "Optional. Average speed in millimeters per second.", +"format": "double", +"type": "number" +}, +"caloriesKcal": { +"description": "Optional. Total calories burned by the user during the exercise.", +"format": "double", +"type": "number" +}, +"distanceMillimeters": { +"description": "Optional. Total distance covered by the user during the exercise.", +"format": "double", +"type": "number" +}, +"elevationGainMillimeters": { +"description": "Optional. Total elevation gain during the exercise.", +"format": "double", +"type": "number" +}, +"heartRateZoneDurations": { +"$ref": "TimeInHeartRateZones", +"description": "Optional. Time spent in each heart rate zone." +}, +"mobilityMetrics": { +"$ref": "MobilityMetrics", +"description": "Optional. Mobility workouts specific metrics. Only present in the advanced running exercises." +}, +"runVo2Max": { +"description": "Optional. Run VO2 max value for the exercise. Only present in the running exercises at the top level as in the summary of the whole exercise.", +"format": "double", +"type": "number" +}, +"steps": { +"description": "Optional. Total steps taken during the exercise.", +"format": "int64", +"type": "string" +}, +"totalSwimLengths": { +"description": "Optional. Number of full pool lengths completed during the exercise. Only present in the swimming exercises at the top level as in the summary of the whole exercise.", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, +"MobilityMetrics": { +"description": "Mobility workouts specific metrics", +"id": "MobilityMetrics", +"properties": { +"avgCadenceStepsPerMinute": { +"description": "Optional. Cadence is a measure of the frequency of your foot strikes. Steps / min in real time during workout.", +"format": "double", +"type": "number" +}, +"avgGroundContactTimeDuration": { +"description": "Optional. The ground contact time for a particular stride is the amount of time for which the foot was in contact with the ground on that stride", +"format": "google-duration", +"type": "string" +}, +"avgStrideLengthMillimeters": { +"description": "Optional. Stride length is a measure of the distance covered by a single stride", +"format": "int64", +"type": "string" +}, +"avgVerticalOscillationMillimeters": { +"description": "Optional. Distance off the ground your center of mass moves with each stride while running", +"format": "int64", +"type": "string" +}, +"avgVerticalRatio": { +"description": "Optional. Vertical oscillation/stride length between [5.0, 11.0].", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, +"ObservationSampleTime": { +"description": "Represents a sample time of an observed data point.", +"id": "ObservationSampleTime", +"properties": { +"civilTime": { +"$ref": "CivilDateTime", +"description": "Output only. The civil time in the timezone the subject is in at the time of the observation.", +"readOnly": true +}, +"physicalTime": { +"description": "Required. The time of the observation.", +"format": "google-datetime", +"type": "string" +}, +"utcOffset": { +"description": "Required. The offset of the user's local time during the observation relative to the Coordinated Universal Time (UTC).", +"format": "google-duration", +"type": "string" +} +}, +"type": "object" +}, +"ObservationTimeInterval": { +"description": "Represents a time interval of an observed data point.", +"id": "ObservationTimeInterval", +"properties": { +"civilEndTime": { +"$ref": "CivilDateTime", +"description": "Output only. Observed interval end time in civil time in the timezone the subject is in at the end of the observed interval", +"readOnly": true +}, +"civilStartTime": { +"$ref": "CivilDateTime", +"description": "Output only. Observed interval start time in civil time in the timezone the subject is in at the start of the observed interval", +"readOnly": true +}, +"endTime": { +"description": "Required. Observed interval end time.", +"format": "google-datetime", +"type": "string" +}, +"endUtcOffset": { +"description": "Required. The offset of the user's local time at the end of the observation relative to the Coordinated Universal Time (UTC).", +"format": "google-duration", +"type": "string" +}, +"startTime": { +"description": "Required. Observed interval start time.", +"format": "google-datetime", +"type": "string" +}, +"startUtcOffset": { +"description": "Required. The offset of the user's local time at the start of the observation relative to the Coordinated Universal Time (UTC).", +"format": "google-duration", +"type": "string" +} +}, +"type": "object" +}, +"Operation": { +"description": "This resource represents a long-running operation that is the result of a network API call.", +"id": "Operation", +"properties": { +"done": { +"description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", +"type": "boolean" +}, +"error": { +"$ref": "Status", +"description": "The error result of the operation in case of failure or cancellation." +}, +"metadata": { +"additionalProperties": { +"description": "Properties of the object. Contains field @type with type URL.", +"type": "any" +}, +"description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", +"type": "object" +}, +"name": { +"description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", +"type": "string" +}, +"response": { +"additionalProperties": { +"description": "Properties of the object. Contains field @type with type URL.", +"type": "any" +}, +"description": "The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", +"type": "object" +} +}, +"type": "object" +}, +"OutOfBedSegment": { +"description": "A time interval to represent an out-of-bed segment.", +"id": "OutOfBedSegment", +"properties": { +"endTime": { +"description": "Required. Segment end time.", +"format": "google-datetime", +"type": "string" +}, +"endUtcOffset": { +"description": "Required. The offset of the user's local time at the end of the segment relative to the Coordinated Universal Time (UTC).", +"format": "google-duration", +"type": "string" +}, +"startTime": { +"description": "Required. Segment tart time.", +"format": "google-datetime", +"type": "string" +}, +"startUtcOffset": { +"description": "Required. The offset of the user's local time at the start of the segment relative to the Coordinated Universal Time (UTC).", +"format": "google-duration", +"type": "string" +} +}, +"type": "object" +}, +"OxygenSaturation": { +"description": "Captures the user's instantaneous oxygen saturation percentage (SpO2).", +"id": "OxygenSaturation", +"properties": { +"percentage": { +"description": "Required. The oxygen saturation percentage. Valid values are from 0 to 100.", +"format": "double", +"type": "number" +}, +"sampleTime": { +"$ref": "ObservationSampleTime", +"description": "Required. The time at which oxygen saturation was measured." +} +}, +"type": "object" +}, +"Profile": { +"description": "Profile details.", +"id": "Profile", +"properties": { +"age": { +"description": "Optional. The age in years based on the user's birth date. Updates to this field are currently not supported.", +"format": "int32", +"type": "integer" +}, +"autoRunningStrideLengthMm": { +"description": "Output only. The automatically calculated running stride length, in millimeters. The user must consent to one of the following access scopes to access this field: - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly` - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness`", +"format": "int32", +"readOnly": true, +"type": "integer" +}, +"autoWalkingStrideLengthMm": { +"description": "Output only. The automatically calculated walking stride length, in millimeters. The user must consent to one of the following access scopes to access this field: - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly` - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness`", +"format": "int32", +"readOnly": true, +"type": "integer" +}, +"membershipStartDate": { +"$ref": "Date", +"description": "Output only. The date the user created their account. Updates to this field are currently not supported.", +"readOnly": true +}, +"name": { +"description": "Identifier. The resource name of this Profile resource. Format: `users/{user}/profile` Example: `users/1234567890/profile` or `users/me/profile` The {user} ID is a system-generated Google Health API user ID, a string of 1-63 characters consisting of lowercase and uppercase letters, numbers, and hyphens. The literal `me` can also be used to refer to the authenticated user.", +"type": "string" +}, +"userConfiguredRunningStrideLengthMm": { +"description": "Optional. The user's user configured running stride length, in millimeters. The user must consent to one of the following access scopes to access this field: - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly` - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness`", +"format": "int32", +"type": "integer" +}, +"userConfiguredWalkingStrideLengthMm": { +"description": "Optional. The user's user configured walking stride length, in millimeters. The user must consent to one of the following access scopes to access this field: - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly` - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness`", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"ReconcileDataPointsResponse": { +"description": "Response containing the list of reconciled DataPoints.", +"id": "ReconcileDataPointsResponse", +"properties": { +"dataPoints": { +"description": "Data points matching the query", +"items": { +"$ref": "ReconciledDataPoint" +}, +"type": "array" +}, +"nextPageToken": { +"description": "Next page token, empty if the response is complete", +"type": "string" +} +}, +"type": "object" +}, +"ReconciledDataPoint": { +"description": "A reconciled computed or recorded metric.", +"id": "ReconciledDataPoint", +"properties": { +"activeMinutes": { +"$ref": "ActiveMinutes", +"description": "Data for points in the `active-minutes` interval data type collection." +}, +"activeZoneMinutes": { +"$ref": "ActiveZoneMinutes", +"description": "Data for points in the `active-zone-minutes` interval data type collection, measured in minutes." +}, +"activityLevel": { +"$ref": "ActivityLevel", +"description": "Data for points in the `activity-level` daily data type collection." +}, +"altitude": { +"$ref": "Altitude", +"description": "Data for points in the `altitude` interval data type collection." +}, +"bodyFat": { +"$ref": "BodyFat", +"description": "Data for points in the `body-fat` sample data type collection." +}, +"dailyHeartRateVariability": { +"$ref": "DailyHeartRateVariability", +"description": "Data for points in the `daily-heart-rate-variability` daily data type collection." +}, +"dailyHeartRateZones": { +"$ref": "DailyHeartRateZones", +"description": "Data for points in the `daily-heart-rate-zones` daily data type collection." +}, +"dailyOxygenSaturation": { +"$ref": "DailyOxygenSaturation", +"description": "Data for points in the `daily-oxygen-saturation` daily data type collection." +}, +"dailyRespiratoryRate": { +"$ref": "DailyRespiratoryRate", +"description": "Data for points in the `daily-respiratory-rate` daily data type collection." +}, +"dailyRestingHeartRate": { +"$ref": "DailyRestingHeartRate", +"description": "Data for points in the `daily-resting-heart-rate` daily data type collection." +}, +"dailySleepTemperatureDerivations": { +"$ref": "DailySleepTemperatureDerivations", +"description": "Data for points in the `daily-sleep-temperature-derivations` daily data type collection." +}, +"dailyVo2Max": { +"$ref": "DailyVO2Max", +"description": "Data for points in the `daily-vo2-max` daily data type collection." +}, +"dataPointName": { +"description": "Identifier. Data point name, only supported for the subset of identifiable data types. For the majority of the data types, individual data points do not need to be identified and this field would be empty. Format: `users/{user}/dataTypes/{data_type}/dataPoints/{data_point}` Example: `users/abcd1234/dataTypes/sleep/dataPoints/a1b2c3d4-e5f6-7890-1234-567890abcdef` The `{user}` ID is a system-generated identifier, as described in Identity.health_user_id. The `{data_type}` ID corresponds to the kebab-case version of the field names in the DataPoint data union field, e.g. `total-calories` for the `total_calories` field. The `{data_point}` ID can be client-provided or system-generated. If client-provided, it must be a string of 4-63 characters, containing only lowercase letters, numbers, and hyphens.", +"type": "string" +}, +"distance": { +"$ref": "Distance", +"description": "Data for points in the `distance` interval data type collection." +}, +"exercise": { +"$ref": "Exercise", +"description": "Data for points in the `exercise` session data type collection." +}, +"floors": { +"$ref": "Floors", +"description": "Data for points in the `floors` interval data type collection." +}, +"heartRate": { +"$ref": "HeartRate", +"description": "Data for points in the `heart-rate` sample data type collection." +}, +"heartRateVariability": { +"$ref": "HeartRateVariability", +"description": "Data for points in the `heart-rate-variability` sample data type collection." +}, +"hydrationLog": { +"$ref": "HydrationLog", +"description": "Data for points in the `hydration-log` session data type collection." +}, +"oxygenSaturation": { +"$ref": "OxygenSaturation", +"description": "Data for points in the `oxygen-saturation` sample data type collection." +}, +"respiratoryRateSleepSummary": { +"$ref": "RespiratoryRateSleepSummary", +"description": "Data for points in the `respiratory-rate-sleep-summary` sample data type collection." +}, +"runVo2Max": { +"$ref": "RunVO2Max", +"description": "Data for points in the `run-vo2-max` sample data type collection." +}, +"sedentaryPeriod": { +"$ref": "SedentaryPeriod", +"description": "Data for points in the `sedentary-period` interval data type collection." +}, +"sleep": { +"$ref": "Sleep", +"description": "Data for points in the `sleep` session data type collection." +}, +"steps": { +"$ref": "Steps", +"description": "Data for points in the `steps` interval data type collection." +}, +"timeInHeartRateZone": { +"$ref": "TimeInHeartRateZone", +"description": "Data for points in the `time-in-heart-rate-zone` interval data type collection." +}, +"vo2Max": { +"$ref": "VO2Max", +"description": "Data for points in the `vo2-max` sample data type collection." +}, +"weight": { +"$ref": "Weight", +"description": "Data for points in the `weight` sample data type collection." +} +}, +"type": "object" +}, +"RespiratoryRateSleepSummary": { +"description": "Records respiratory rate details during sleep. Can have multiple per day if the user sleeps multiple times.", +"id": "RespiratoryRateSleepSummary", +"properties": { +"deepSleepStats": { +"$ref": "RespiratoryRateSleepSummaryStatistics", +"description": "Optional. Respiratory rate statistics for deep sleep." +}, +"fullSleepStats": { +"$ref": "RespiratoryRateSleepSummaryStatistics", +"description": "Required. Full respiratory rate statistics." +}, +"lightSleepStats": { +"$ref": "RespiratoryRateSleepSummaryStatistics", +"description": "Optional. Respiratory rate statistics for light sleep." +}, +"remSleepStats": { +"$ref": "RespiratoryRateSleepSummaryStatistics", +"description": "Optional. Respiratory rate statistics for REM sleep." +}, +"sampleTime": { +"$ref": "ObservationSampleTime", +"description": "Required. The time at which respiratory rate was measured." +} +}, +"type": "object" +}, +"RespiratoryRateSleepSummaryStatistics": { +"description": "Respiratory rate statistics for a given sleep stage.", +"id": "RespiratoryRateSleepSummaryStatistics", +"properties": { +"breathsPerMinute": { +"description": "Required. Average breaths per minute.", +"format": "double", +"type": "number" +}, +"signalToNoise": { +"description": "Optional. How trustworthy the data is for the computation.", +"format": "double", +"type": "number" +}, +"standardDeviation": { +"description": "Optional. Standard deviation of the respiratory rate during sleep.", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, +"RestingHeartRatePersonalRangeRollupValue": { +"description": "Represents the rollup value for the daily resting heart rate data type.", +"id": "RestingHeartRatePersonalRangeRollupValue", +"properties": { +"beatsPerMinuteMax": { +"description": "The upper bound of the user's daily resting heart rate personal range.", +"format": "double", +"type": "number" +}, +"beatsPerMinuteMin": { +"description": "The lower bound of the user's daily resting heart rate personal range.", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, +"RollUpDataPointsRequest": { +"description": "Request to roll up data points by physical time intervals.", +"id": "RollUpDataPointsRequest", +"properties": { +"dataSourceFamily": { +"description": "Optional. The data source family name to roll up. If empty, data points from all available data sources will be rolled up. Format: `users/me/dataSourceFamilies/{data_source_family}` The supported values are: - `users/me/dataSourceFamilies/all-sources` - default value - `users/me/dataSourceFamilies/google-wearables` - tracker devices - `users/me/dataSourceFamilies/google-sources` - Google first party sources", +"type": "string" +}, +"pageSize": { +"description": "Optional. The maximum number of data points to return. If unspecified, at most 1440 data points will be returned. The maximum page size is 10000; values above that will be truncated accordingly.", +"format": "int32", +"type": "integer" +}, +"pageToken": { +"description": "Optional. The next_page_token from a previous request, if any. All other request fields need to be the same as in the initial request when the page token is specified.", +"type": "string" +}, +"range": { +"$ref": "Interval", +"description": "Required. Closed-open range of data points that will be rolled up. The maximum range for `calories-in-heart-rate-zone`, `heart-rate`, `active-minutes` and `total-calories` is 14 days. The maximum range for all other data types is 90 days." +}, +"windowSize": { +"description": "Required. The size of the time window to group data points into before applying the aggregation functions.", +"format": "google-duration", +"type": "string" +} +}, +"type": "object" +}, +"RollUpDataPointsResponse": { +"description": "Response containing the list of rolled up data points.", +"id": "RollUpDataPointsResponse", +"properties": { +"nextPageToken": { +"description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", +"type": "string" +}, +"rollupDataPoints": { +"description": "Values for each aggregation time window.", +"items": { +"$ref": "RollupDataPoint" +}, +"type": "array" +} +}, +"type": "object" +}, +"RollupDataPoint": { +"description": "Value of a rollup for a single physical time interval (aggregation window)", +"id": "RollupDataPoint", +"properties": { +"activeMinutes": { +"$ref": "ActiveMinutesRollupValue", +"description": "Returned by default when rolling up data points from the `active-minutes` data type, or when requested explicitly using the `active-minutes` rollup type identifier." +}, +"activeZoneMinutes": { +"$ref": "ActiveZoneMinutesRollupValue", +"description": "Returned by default when rolling up data points from the `active-zone-minutes` data type, or when requested explicitly using the `active-zone-minutes` rollup type identifier." +}, +"activityLevel": { +"$ref": "ActivityLevelRollupValue", +"description": "Returned by default when rolling up data points from the `activity-level` data type, or when requested explicitly using the `activity-level` rollup type identifier." +}, +"altitude": { +"$ref": "AltitudeRollupValue", +"description": "Returned by default when rolling up data points from the `altitude` data type, or when requested explicitly using the `altitude` rollup type identifier." +}, +"bodyFat": { +"$ref": "BodyFatRollupValue", +"description": "Returned by default when rolling up data points from the `body-fat` data type, or when requested explicitly using the `body-fat` rollup type identifier." +}, +"caloriesInHeartRateZone": { +"$ref": "CaloriesInHeartRateZoneRollupValue", +"description": "Returned by default when rolling up data points from the `calories-in-heart-rate-zone` data type, or when requested explicitly using the `calories-in-heart-rate-zone` rollup type identifier." +}, +"distance": { +"$ref": "DistanceRollupValue", +"description": "Returned by default when rolling up data points from the `distance` data type, or when requested explicitly using the `distance` rollup type identifier." +}, +"endTime": { +"description": "End time of the window this value aggregates over", +"format": "google-datetime", +"type": "string" +}, +"floors": { +"$ref": "FloorsRollupValue", +"description": "Returned by default when rolling up data points from the `floors` data type, or when requested explicitly using the `floors` rollup type identifier." +}, +"heartRate": { +"$ref": "HeartRateRollupValue", +"description": "Returned by default when rolling up data points from the `heart-rate` data type, or when requested explicitly using the `heart-rate` rollup type identifier." +}, +"hydrationLog": { +"$ref": "HydrationLogRollupValue", +"description": "Returned by default when rolling up data points from the `hydration-log` data type, or when requested explicitly using the `hydration-log` rollup type identifier." +}, +"runVo2Max": { +"$ref": "RunVO2MaxRollupValue", +"description": "Returned by default when rolling up data points from the `run-vo2-max` data type, or when requested explicitly using the `run-vo2-max` rollup type identifier." +}, +"sedentaryPeriod": { +"$ref": "SedentaryPeriodRollupValue", +"description": "Returned by default when rolling up data points from the `sedentary-period` data type, or when requested explicitly using the `sedentary-period` rollup type identifier." +}, +"startTime": { +"description": "Start time of the window this value aggregates over", +"format": "google-datetime", +"type": "string" +}, +"steps": { +"$ref": "StepsRollupValue", +"description": "Returned by default when rolling up data points from the `steps` data type, or when requested explicitly using the `steps` rollup type identifier." +}, +"timeInHeartRateZone": { +"$ref": "TimeInHeartRateZoneRollupValue", +"description": "Returned by default when rolling up data points from the `time-in-heart-rate-zone` data type, or when requested explicitly using the `time-in-heart-rate-zone` rollup type identifier." +}, +"totalCalories": { +"$ref": "TotalCaloriesRollupValue", +"description": "Returned by default when rolling up data points from the `total-calories` data type, or when requested explicitly using the `total-calories` rollup type identifier." +}, +"weight": { +"$ref": "WeightRollupValue", +"description": "Returned by default when rolling up data points from the `weight` data type, or when requested explicitly using the `weight` rollup type identifier." +} +}, +"type": "object" +}, +"RunVO2Max": { +"description": "VO2 max value calculated based on the user's running activity. Value stored in ml/kg/min.", +"id": "RunVO2Max", +"properties": { +"runVo2Max": { +"description": "Required. Run VO2 max value in ml/kg/min.", +"format": "double", +"type": "number" +}, +"sampleTime": { +"$ref": "ObservationSampleTime", +"description": "Required. The time at which the metric was measured." +} +}, +"type": "object" +}, +"RunVO2MaxRollupValue": { +"description": "Represents the result of the rollup of the user's daily heart rate variability personal range.", +"id": "RunVO2MaxRollupValue", +"properties": { +"rateAvg": { +"description": "Average value of run VO2 max in the interval.", +"format": "double", +"type": "number" +}, +"rateMax": { +"description": "Maximum value of run VO2 max in the interval.", +"format": "double", +"type": "number" +}, +"rateMin": { +"description": "Minimum value of run VO2 max in the interval..", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, +"SedentaryPeriod": { +"description": "SedentaryPeriod SedentaryPeriod data represents the periods of time that the user was sedentary (i.e. not moving while wearing the device).", +"id": "SedentaryPeriod", +"properties": { +"interval": { +"$ref": "ObservationTimeInterval", +"description": "Required. Observed interval." +} +}, +"type": "object" +}, +"SedentaryPeriodRollupValue": { +"description": "Represents the result of the rollup of the user's sedentary periods.", +"id": "SedentaryPeriodRollupValue", +"properties": { +"durationSum": { +"description": "The total time user spent sedentary during the interval.", +"format": "google-duration", +"type": "string" +} +}, +"type": "object" +}, +"SessionTimeInterval": { +"description": "Represents a time interval of session data point, which bundles multiple observed metrics together.", +"id": "SessionTimeInterval", +"properties": { +"civilEndTime": { +"$ref": "CivilDateTime", +"description": "Output only. Session end time in civil time in the timezone the subject is in at the end of the session.", +"readOnly": true +}, +"civilStartTime": { +"$ref": "CivilDateTime", +"description": "Output only. Session start time in civil time in the timezone the subject is in at the start of the session.", +"readOnly": true +}, +"endTime": { +"description": "Required. The end time of the observed session.", +"format": "google-datetime", +"type": "string" +}, +"endUtcOffset": { +"description": "Required. The offset of the user's local time at the end of the session relative to the Coordinated Universal Time (UTC).", +"format": "google-duration", +"type": "string" +}, +"startTime": { +"description": "Required. The start time of the observed session.", +"format": "google-datetime", +"type": "string" +}, +"startUtcOffset": { +"description": "Required. The offset of the user's local time at the start of the session relative to the Coordinated Universal Time (UTC).", +"format": "google-duration", +"type": "string" +} +}, +"type": "object" +}, +"Settings": { +"description": "Settings details.", +"id": "Settings", +"properties": { +"autoStrideEnabled": { +"description": "Optional. True if the user's stride length is determined automatically. Updates to this field are currently not supported.", +"type": "boolean" +}, +"distanceUnit": { +"description": "Optional. The measurement unit defined in the user's account settings. Updates to this field are currently not supported.", +"enum": [ +"DISTANCE_UNIT_UNSPECIFIED", +"DISTANCE_UNIT_MILES", +"DISTANCE_UNIT_KILOMETERS" +], +"enumDescriptions": [ +"Distance unit is not specified.", +"Distance unit is miles.", +"Distance unit is kilometers." +], +"type": "string" +}, +"glucoseUnit": { +"description": "Optional. The measurement unit defined in the user's account settings.", +"enum": [ +"GLUCOSE_UNIT_UNSPECIFIED", +"GLUCOSE_UNIT_MG_DL", +"GLUCOSE_UNIT_MMOL_L" +], +"enumDescriptions": [ +"Glucose unit is not specified.", +"Glucose unit is mg/dL.", +"Glucose unit is mmol/l." +], +"type": "string" +}, +"heightUnit": { +"description": "Optional. The measurement unit defined in the user's account settings.", +"enum": [ +"HEIGHT_UNIT_UNSPECIFIED", +"HEIGHT_UNIT_INCHES", +"HEIGHT_UNIT_CENTIMETERS" +], +"enumDescriptions": [ +"Height unit is not specified.", +"Height unit is inches.", +"Height unit is cm." +], +"type": "string" +}, +"languageLocale": { +"description": "Optional. The locale defined in the user's account settings. Updates to this field are currently not supported.", +"type": "string" +}, +"name": { +"description": "Identifier. The resource name of this Settings resource. Format: `users/{user}/settings` Example: `users/1234567890/settings` or `users/me/settings` The {user} ID is a system-generated Google Health API user ID, a string of 1-63 characters consisting of lowercase and uppercase letters, numbers, and hyphens. The literal `me` can also be used to refer to the authenticated user.", +"type": "string" +}, +"strideLengthRunningType": { +"description": "Optional. The stride length type defined in the user's account settings for running. Updates to this field are currently not supported.", +"enum": [ +"STRIDE_LENGTH_TYPE_UNSPECIFIED", +"STRIDE_LENGTH_TYPE_DEFAULT", +"STRIDE_LENGTH_TYPE_MANUAL", +"STRIDE_LENGTH_TYPE_AUTO" +], +"enumDescriptions": [ +"Stride length type is not specified.", +"Stride length type is computed based on the user's gender and height.", +"Stride length type is manually set by the user.", +"Stride length type is determined automatically." +], +"type": "string" +}, +"strideLengthWalkingType": { +"description": "Optional. The stride length type defined in the user's account settings for walking. Updates to this field are currently not supported.", +"enum": [ +"STRIDE_LENGTH_TYPE_UNSPECIFIED", +"STRIDE_LENGTH_TYPE_DEFAULT", +"STRIDE_LENGTH_TYPE_MANUAL", +"STRIDE_LENGTH_TYPE_AUTO" +], +"enumDescriptions": [ +"Stride length type is not specified.", +"Stride length type is computed based on the user's gender and height.", +"Stride length type is manually set by the user.", +"Stride length type is determined automatically." +], +"type": "string" +}, +"swimUnit": { +"description": "Optional. The measurement unit defined in the user's account settings.", +"enum": [ +"SWIM_UNIT_UNSPECIFIED", +"SWIM_UNIT_METERS", +"SWIM_UNIT_YARDS" +], +"enumDescriptions": [ +"Swim unit is not specified.", +"Swim unit is meters.", +"Swim unit is yards." +], +"type": "string" +}, +"temperatureUnit": { +"description": "Optional. The measurement unit defined in the user's account settings.", +"enum": [ +"TEMPERATURE_UNIT_UNSPECIFIED", +"TEMPERATURE_UNIT_CELSIUS", +"TEMPERATURE_UNIT_FAHRENHEIT" +], +"enumDescriptions": [ +"Temperature unit is not specified.", +"Temperature unit is Celsius.", +"Temperature unit is Fahrenheit." +], +"type": "string" +}, +"timeZone": { +"description": "Optional. The timezone defined in the user's account settings. This follows the IANA [Time Zone Database](https://www.iana.org/time-zones). Updates to this field are currently not supported.", +"type": "string" +}, +"utcOffset": { +"description": "Optional. The user's timezone offset relative to UTC. Updates to this field are currently not supported.", +"format": "google-duration", +"type": "string" +}, +"waterUnit": { +"description": "Optional. The measurement unit defined in the user's account settings.", +"enum": [ +"WATER_UNIT_UNSPECIFIED", +"WATER_UNIT_ML", +"WATER_UNIT_FL_OZ", +"WATER_UNIT_CUP" +], +"enumDescriptions": [ +"Water unit is not specified.", +"Water unit is milliliters.", +"Water unit is fluid ounces.", +"Water unit is cups." +], +"type": "string" +}, +"weightUnit": { +"description": "Optional. The measurement unit defined in the user's account settings.", +"enum": [ +"WEIGHT_UNIT_UNSPECIFIED", +"WEIGHT_UNIT_POUNDS", +"WEIGHT_UNIT_STONE", +"WEIGHT_UNIT_KILOGRAMS" +], +"enumDescriptions": [ +"Weight unit is not specified.", +"Weight unit is pounds.", +"Weight unit is stones.", +"Weight unit is kilograms." +], +"type": "string" +} +}, +"type": "object" +}, +"Sleep": { +"description": "A sleep session possibly including stages.", +"id": "Sleep", +"properties": { +"createTime": { +"description": "Output only. Creation time of this sleep observation.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"interval": { +"$ref": "SessionTimeInterval", +"description": "Required. Observed sleep interval." +}, +"metadata": { +"$ref": "SleepMetadata", +"description": "Optional. Sleep metadata: processing, main, manually edited, stages status." +}, +"outOfBedSegments": { +"description": "Optional. \u201cOut of bed\u201d segments that can overlap with sleep stages.", +"items": { +"$ref": "OutOfBedSegment" +}, +"type": "array" +}, +"stages": { +"description": "Optional. List of non-overlapping contiguous sleep stage segments that cover the sleep period.", +"items": { +"$ref": "SleepStage" +}, +"type": "array" +}, +"summary": { +"$ref": "SleepSummary", +"description": "Output only. Sleep summary: metrics and stages summary.", +"readOnly": true +}, +"type": { +"description": "Optional. SleepType: classic or stages.", +"enum": [ +"SLEEP_TYPE_UNSPECIFIED", +"CLASSIC", +"STAGES" +], +"enumDescriptions": [ +"Sleep type is unspecified.", +"Classic sleep is a sleep with 3 stages types: AWAKE, RESTLESS and ASLEEP.", +"On top of \"classic\" sleep stages an additional processing pass can calculate stages more precisely, overwriting the prior stages with AWAKE, LIGHT, REM and DEEP." +], +"type": "string" +}, +"updateTime": { +"description": "Output only. Last update time of this sleep observation.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"SleepMetadata": { +"description": "Additional information about how the sleep was processed.", +"id": "SleepMetadata", +"properties": { +"externalId": { +"description": "Optional. Sleep identifier relevant in the context of the data source.", +"type": "string" +}, +"manuallyEdited": { +"description": "Output only. Some sleeps autodetected by algorithms can be manually edited by users.", +"readOnly": true, +"type": "boolean" +}, +"nap": { +"description": "Output only. Naps are sleeps without stages and relatively short durations.", +"readOnly": true, +"type": "boolean" +}, +"processed": { +"description": "Output only. Sleep and sleep stages algorithms finished processing.", +"readOnly": true, +"type": "boolean" +}, +"stagesStatus": { +"description": "Output only. Sleep stages algorithm processing status.", +"enum": [ +"STAGES_STATE_UNSPECIFIED", +"REJECTED_COVERAGE", +"REJECTED_MAX_GAP", +"REJECTED_START_GAP", +"REJECTED_END_GAP", +"REJECTED_NAP", +"REJECTED_SERVER", +"TIMEOUT", +"SUCCEEDED", +"PROCESSING_INTERNAL_ERROR" +], +"enumDescriptions": [ +"Output only. Sleep stages status is unspecified.", +"Output only. Sleep stages cannot be computed due to low RR coverage.", +"Output only. Sleep stages cannot be computed due to the large middle gap (2h).", +"Output only. Sleep stages cannot be computed due to the large start gap (1h).", +"Output only. Sleep stages cannot be computed due to the large end gap (1h).", +"Output only. Sleep stages cannot be computed because the sleep log is a nap (has < 3h duration).", +"Output only. Sleep stages cannot be computed because input data is not available (PPGV2, wake magnitude, etc).", +"Output only. Sleep stages cannot be computed due to server timeout.", +"Output only. Sleep stages successfully computed.", +"Output only. Sleep stages cannot be computed due to server internal error." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"SleepStage": { +"description": "Sleep stage segment.", +"id": "SleepStage", +"properties": { +"createTime": { +"description": "Output only. Creation time of this sleep stages segment.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"endTime": { +"description": "Required. Sleep stage end time.", +"format": "google-datetime", +"type": "string" +}, +"endUtcOffset": { +"description": "Required. The offset of the user's local time at the end of the sleep stage relative to the Coordinated Universal Time (UTC).", +"format": "google-duration", +"type": "string" +}, +"startTime": { +"description": "Required. Sleep stage start time.", +"format": "google-datetime", +"type": "string" +}, +"startUtcOffset": { +"description": "Required. The offset of the user's local time at the start of the sleep stage relative to the Coordinated Universal Time (UTC).", +"format": "google-duration", +"type": "string" +}, +"type": { +"description": "Required. Sleep stage type: AWAKE, DEEP, REM, LIGHT etc.", +"enum": [ +"SLEEP_STAGE_TYPE_UNSPECIFIED", +"AWAKE", +"LIGHT", +"DEEP", +"REM", +"ASLEEP", +"RESTLESS" +], +"enumDescriptions": [ +"The default unset value.", +"Sleep stage AWAKE.", +"Sleep stage LIGHT.", +"Sleep stage DEEP.", +"Sleep stage REM.", +"Sleep stage ASLEEP.", +"Sleep stage RESTLESS." +], +"type": "string" +}, +"updateTime": { +"description": "Output only. Last update time of this sleep stages segment.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"SleepSummary": { +"description": " Sleep summary: metrics and stages summary.", +"id": "SleepSummary", +"properties": { +"minutesAfterWakeUp": { +"description": "Output only. Minutes after wake up calculated by restlessness algorithm.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"minutesAsleep": { +"description": "Output only. Total number of minutes asleep. For classic sleep it is the sum of ASLEEP stages (excluding AWAKE and RESTLESS). For \"stages\" sleep it is the sum of LIGHT, REM and DEEP stages (excluding AWAKE).", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"minutesAwake": { +"description": "Output only. Total number of minutes awake. It is a sum of all AWAKE stages.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"minutesInSleepPeriod": { +"description": "Output only. Delta between wake time and bedtime. It is the sum of all stages.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"minutesToFallAsleep": { +"description": "Output only. Minutes to fall asleep calculated by restlessness algorithm.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"stagesSummary": { +"description": "Output only. List of summaries (total duration and segment count) per each sleep stage type.", +"items": { +"$ref": "StageSummary" +}, +"readOnly": true, +"type": "array" +} +}, +"type": "object" +}, +"SplitSummary": { +"description": "Represents splits or laps recorded within an exercise. Lap events partition a workout into segments based on criteria like distance, time, or calories.", +"id": "SplitSummary", +"properties": { +"activeDuration": { +"description": "Output only. Lap time excluding the pauses.", +"format": "google-duration", +"readOnly": true, +"type": "string" +}, +"endTime": { +"description": "Required. Lap end time", +"format": "google-datetime", +"type": "string" +}, +"endUtcOffset": { +"description": "Required. Lap end time offset from UTC", +"format": "google-duration", +"type": "string" +}, +"metricsSummary": { +"$ref": "MetricsSummary", +"description": "Required. Summary metrics for this split." +}, +"splitType": { +"description": "Required. Method used to split the exercise laps. Users may manually mark the lap as complete even if the tracking is automatic.", +"enum": [ +"SPLIT_TYPE_UNSPECIFIED", +"MANUAL", +"DURATION", +"DISTANCE", +"CALORIES" +], +"enumDescriptions": [ +"Split type is unspecified.", +"Manual split.", +"Split by duration.", +"Split by distance.", +"Split by calories." +], +"type": "string" +}, +"startTime": { +"description": "Required. Lap start time", +"format": "google-datetime", +"type": "string" +}, +"startUtcOffset": { +"description": "Required. Lap start time offset from UTC", +"format": "google-duration", +"type": "string" +} +}, +"type": "object" +}, +"StageSummary": { +"description": "Total duration and segment count for a stage.", +"id": "StageSummary", +"properties": { +"count": { +"description": "Output only. Number of sleep stages segments.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"minutes": { +"description": "Output only. Total duration in minutes of a sleep stage.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"type": { +"description": "Output only. Sleep stage type: AWAKE, DEEP, REM, LIGHT etc.", +"enum": [ +"SLEEP_STAGE_TYPE_UNSPECIFIED", +"AWAKE", +"LIGHT", +"DEEP", +"REM", +"ASLEEP", +"RESTLESS" +], +"enumDescriptions": [ +"The default unset value.", +"Sleep stage AWAKE.", +"Sleep stage LIGHT.", +"Sleep stage DEEP.", +"Sleep stage REM.", +"Sleep stage ASLEEP.", +"Sleep stage RESTLESS." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"Status": { +"description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", +"id": "Status", +"properties": { +"code": { +"description": "The status code, which should be an enum value of google.rpc.Code.", +"format": "int32", +"type": "integer" +}, +"details": { +"description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", +"items": { +"additionalProperties": { +"description": "Properties of the object. Contains field @type with type URL.", +"type": "any" +}, +"type": "object" +}, +"type": "array" +}, +"message": { +"description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", +"type": "string" +} +}, +"type": "object" +}, +"Steps": { +"description": "Step count over the time interval.", +"id": "Steps", +"properties": { +"count": { +"description": "Required. Number of steps in the recorded interval.", +"format": "int64", +"type": "string" +}, +"interval": { +"$ref": "ObservationTimeInterval", +"description": "Required. Observed interval." +} +}, +"type": "object" +}, +"StepsRollupValue": { +"description": "Represents the result of the rollup of the steps data type.", +"id": "StepsRollupValue", +"properties": { +"countSum": { +"description": "Total number of steps in the interval.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"TimeInHeartRateZone": { +"description": "Time in heart rate zone record. It's an interval spent in specific heart rate zone.", +"id": "TimeInHeartRateZone", +"properties": { +"heartRateZoneType": { +"description": "Required. Heart rate zone type.", +"enum": [ +"HEART_RATE_ZONE_TYPE_UNSPECIFIED", +"LIGHT", +"MODERATE", +"VIGOROUS", +"PEAK" +], +"enumDescriptions": [ +"Unspecified heart rate zone.", +"The light heart rate zone.", +"The moderate heart rate zone.", +"The vigorous heart rate zone.", +"The peak heart rate zone." +], +"type": "string" +}, +"interval": { +"$ref": "ObservationTimeInterval", +"description": "Required. Observed interval." +} +}, +"type": "object" +}, +"TimeInHeartRateZoneRollupValue": { +"description": "Represents the result of the rollup of the time in heart rate zone data type.", +"id": "TimeInHeartRateZoneRollupValue", +"properties": { +"timeInHeartRateZones": { +"description": "List of time spent in each heart rate zone.", +"items": { +"$ref": "TimeInHeartRateZoneValue" +}, +"type": "array" +} +}, +"type": "object" +}, +"TimeInHeartRateZoneValue": { +"description": "Represents the total time spent in a specific heart rate zone.", +"id": "TimeInHeartRateZoneValue", +"properties": { +"duration": { +"description": "The total time spent in the specified heart rate zone.", +"format": "google-duration", +"type": "string" +}, +"heartRateZone": { +"description": "The heart rate zone.", +"enum": [ +"HEART_RATE_ZONE_TYPE_UNSPECIFIED", +"LIGHT", +"MODERATE", +"VIGOROUS", +"PEAK" +], +"enumDescriptions": [ +"Unspecified heart rate zone.", +"The light heart rate zone.", +"The moderate heart rate zone.", +"The vigorous heart rate zone.", +"The peak heart rate zone." +], +"type": "string" +} +}, +"type": "object" +}, +"TimeInHeartRateZones": { +"description": "Time spent in each heart rate zone.", +"id": "TimeInHeartRateZones", +"properties": { +"lightTime": { +"description": "Optional. Time spent in light heart rate zone.", +"format": "google-duration", +"type": "string" +}, +"moderateTime": { +"description": "Optional. Time spent in moderate heart rate zone.", +"format": "google-duration", +"type": "string" +}, +"peakTime": { +"description": "Optional. Time spent in peak heart rate zone.", +"format": "google-duration", +"type": "string" +}, +"vigorousTime": { +"description": "Optional. Time spent in vigorous heart rate zone.", +"format": "google-duration", +"type": "string" +} +}, +"type": "object" +}, +"TimeOfDay": { +"description": "Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`.", +"id": "TimeOfDay", +"properties": { +"hours": { +"description": "Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.", +"format": "int32", +"type": "integer" +}, +"minutes": { +"description": "Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.", +"format": "int32", +"type": "integer" +}, +"nanos": { +"description": "Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.", +"format": "int32", +"type": "integer" +}, +"seconds": { +"description": "Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"TimeZone": { +"description": "Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones).", +"id": "TimeZone", +"properties": { +"id": { +"description": "IANA Time Zone Database time zone. For example \"America/New_York\".", +"type": "string" +}, +"version": { +"description": "Optional. IANA Time Zone Database version number. For example \"2019a\".", +"type": "string" +} +}, +"type": "object" +}, +"TotalCaloriesRollupValue": { +"description": "Represents the result of the rollup of the user's total calories.", +"id": "TotalCaloriesRollupValue", +"properties": { +"kcalSum": { +"description": "Sum of the total calories in kilocalories.", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, +"VO2Max": { +"description": "VO2 max measurement.", +"id": "VO2Max", +"properties": { +"measurementMethod": { +"description": "Optional. The method used to measure the VO2 max value.", +"enum": [ +"MEASUREMENT_METHOD_UNSPECIFIED", +"FITBIT_RUN", +"GOOGLE_DEMOGRAPHIC", +"COOPER_TEST", +"HEART_RATE_RATIO", +"METABOLIC_CART", +"MULTISTAGE_FITNESS_TEST", +"ROCKPORT_FITNESS_TEST", +"MAX_EXERCISE", +"PREDICTION_SUB_MAX_EXERCISE", +"PREDICTION_NON_EXERCISE", +"OTHER" +], +"enumDescriptions": [ +"Unspecified measurement method.", +"Fitbit specific, measures VO2 max rate during a run.", +"Google specific, measures VO2 max rate for a user based on their demographic data.", +"Run as far as possible for 12 minutes. Distance correlated with age and gender translates to a VO2 max value.", +"Maximum heart rate divided by the resting heart rate, with a multiplier applied. Does not require any exercise.", +"Measured by a medical device called metabolic cart.", +"Continuous 20m back-and-forth runs with increasing difficulty, until exhaustion.", +"Measured using walking exercise.", +"Healthkit specific, measures VO2 max rate by monitoring exercise to the user\u2019s physical limit. Similar to COOPER_TEST or MULTISTAGE_FITNESS_TEST.", +"Healthkit specific, estimates VO2 max rate based on low-intensity exercise. Similar to ROCKPORT_FITNESS_TEST.", +"Healthkit specific, estimates VO2 max rate without any exercise. Similar to HEART_RATE_RATIO.", +"Use when the method is not covered in this enum." +], +"type": "string" +}, +"sampleTime": { +"$ref": "ObservationSampleTime", +"description": "Required. The time at which VO2 max was measured." +}, +"vo2Max": { +"description": "Required. VO2 max value measured as in ml consumed oxygen / kg of body weight / min.", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, +"VolumeQuantity": { +"description": "Represents the volume quantity.", +"id": "VolumeQuantity", +"properties": { +"milliliters": { +"description": "Required. Value representing the volume in milliliters.", +"format": "double", +"type": "number" +}, +"userProvidedUnit": { +"description": "Optional. Value representing the user provided unit.", +"enum": [ +"VOLUME_UNIT_UNSPECIFIED", +"CUP_IMPERIAL", +"CUP_US", +"FLUID_OUNCE_IMPERIAL", +"FLUID_OUNCE_US", +"LITER", +"MILLILITER", +"PINT_IMPERIAL", +"PINT_US" +], +"enumDescriptions": [ +"Unspecified volume unit.", +"Cup (imperial)", +"Cup (US)", +"Fluid ounce (imperial)", +"Fluid ounce (US)", +"Liter", +"Milliliter", +"Pint (imperial)", +"Pint (US)" +], +"type": "string" +} +}, +"type": "object" +}, +"VolumeQuantityRollup": { +"description": "Rollup for volume quantity.", +"id": "VolumeQuantityRollup", +"properties": { +"millilitersSum": { +"description": "Required. The sum of volume in milliliters.", +"format": "double", +"type": "number" +}, +"userProvidedUnitLast": { +"description": "Optional. The user provided unit on the last element.", +"enum": [ +"VOLUME_UNIT_UNSPECIFIED", +"CUP_IMPERIAL", +"CUP_US", +"FLUID_OUNCE_IMPERIAL", +"FLUID_OUNCE_US", +"LITER", +"MILLILITER", +"PINT_IMPERIAL", +"PINT_US" +], +"enumDescriptions": [ +"Unspecified volume unit.", +"Cup (imperial)", +"Cup (US)", +"Fluid ounce (imperial)", +"Fluid ounce (US)", +"Liter", +"Milliliter", +"Pint (imperial)", +"Pint (US)" +], +"type": "string" +} +}, +"type": "object" +}, +"Weight": { +"description": "Body weight measurement.", +"id": "Weight", +"properties": { +"notes": { +"description": "Optional. Standard free-form notes captured at manual logging.", +"type": "string" +}, +"sampleTime": { +"$ref": "ObservationSampleTime", +"description": "Required. The time at which the weight was measured" +}, +"weightGrams": { +"description": "Required. Weight of a user in grams.", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, +"WeightRollupValue": { +"description": "Represents the result of the rollup of the weight data type.", +"id": "WeightRollupValue", +"properties": { +"weightGramsAvg": { +"description": "Average weight in grams.", +"format": "double", +"type": "number" +} +}, +"type": "object" +} +}, +"servicePath": "", +"title": "Google Health API", +"version": "v4", +"version_module": true +} \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/healthcare.v1.json b/googleapiclient/discovery_cache/documents/healthcare.v1.json index 45f09eff0c..c0da6af00d 100644 --- a/googleapiclient/discovery_cache/documents/healthcare.v1.json +++ b/googleapiclient/discovery_cache/documents/healthcare.v1.json @@ -139,7 +139,7 @@ ] }, "list": { -"description": "Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.", +"description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "flatPath": "v1/projects/{projectsId}/locations", "httpMethod": "GET", "id": "healthcare.projects.locations.list", @@ -5171,7 +5171,7 @@ } } }, -"revision": "20260128", +"revision": "20260331", "rootUrl": "https://healthcare.googleapis.com/", "schemas": { "AccessDeterminationLogConfig": { diff --git a/googleapiclient/discovery_cache/documents/healthcare.v1beta1.json b/googleapiclient/discovery_cache/documents/healthcare.v1beta1.json index 2fc87246f1..779f7486c0 100644 --- a/googleapiclient/discovery_cache/documents/healthcare.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/healthcare.v1beta1.json @@ -139,7 +139,7 @@ ] }, "list": { -"description": "Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.", +"description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "flatPath": "v1beta1/projects/{projectsId}/locations", "httpMethod": "GET", "id": "healthcare.projects.locations.list", @@ -5718,7 +5718,7 @@ } } }, -"revision": "20260128", +"revision": "20260331", "rootUrl": "https://healthcare.googleapis.com/", "schemas": { "AccessDeterminationLogConfig": { diff --git a/googleapiclient/discovery_cache/documents/hypercomputecluster.v1.json b/googleapiclient/discovery_cache/documents/hypercomputecluster.v1.json index 975a1a05b5..e0e565bedf 100644 --- a/googleapiclient/discovery_cache/documents/hypercomputecluster.v1.json +++ b/googleapiclient/discovery_cache/documents/hypercomputecluster.v1.json @@ -135,7 +135,7 @@ ] }, "list": { -"description": "Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.", +"description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "flatPath": "v1/projects/{projectsId}/locations", "httpMethod": "GET", "id": "hypercomputecluster.projects.locations.list", @@ -498,7 +498,7 @@ } } }, -"revision": "20260311", +"revision": "20260325", "rootUrl": "https://hypercomputecluster.googleapis.com/", "schemas": { "BootDisk": { diff --git a/googleapiclient/discovery_cache/documents/iamcredentials.v1.json b/googleapiclient/discovery_cache/documents/iamcredentials.v1.json index 500f74b632..0428881607 100644 --- a/googleapiclient/discovery_cache/documents/iamcredentials.v1.json +++ b/googleapiclient/discovery_cache/documents/iamcredentials.v1.json @@ -151,7 +151,7 @@ ], "parameters": { "name": { -"description": "Required. Resource name of workforce pool.", +"description": "Required. Resource name of workforce pool. Format: `locations/global/workforcePools/{pool_id}`", "location": "path", "pattern": "^locations/[^/]+/workforcePools/[^/]+$", "required": true, @@ -183,7 +183,7 @@ ], "parameters": { "name": { -"description": "Required. Resource name of workload identity pool.", +"description": "Required. Resource name of workload identity pool. Format: `projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/workloadIdentityPools/[^/]+$", "required": true, @@ -267,7 +267,7 @@ ], "parameters": { "name": { -"description": "Required. Resource name of service account.", +"description": "Required. Resource name of service account. Format: `projects/-/serviceAccounts/{service_account_email}`", "location": "path", "pattern": "^projects/[^/]+/serviceAccounts/[^/]+$", "required": true, @@ -340,7 +340,7 @@ } } }, -"revision": "20251022", +"revision": "20260326", "rootUrl": "https://iamcredentials.googleapis.com/", "schemas": { "GenerateAccessTokenRequest": { diff --git a/googleapiclient/discovery_cache/documents/ids.v1.json b/googleapiclient/discovery_cache/documents/ids.v1.json index 6eb90b28b8..48ff2c7855 100644 --- a/googleapiclient/discovery_cache/documents/ids.v1.json +++ b/googleapiclient/discovery_cache/documents/ids.v1.json @@ -135,7 +135,7 @@ ] }, "list": { -"description": "Lists information about the supported locations for this service.", +"description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "flatPath": "v1/projects/{projectsId}/locations", "httpMethod": "GET", "id": "ids.projects.locations.list", @@ -498,7 +498,7 @@ } } }, -"revision": "20251201", +"revision": "20260330", "rootUrl": "https://ids.googleapis.com/", "schemas": { "CancelOperationRequest": { diff --git a/googleapiclient/discovery_cache/documents/logging.v2.json b/googleapiclient/discovery_cache/documents/logging.v2.json index efc726e8d2..779bb04280 100644 --- a/googleapiclient/discovery_cache/documents/logging.v2.json +++ b/googleapiclient/discovery_cache/documents/logging.v2.json @@ -290,6 +290,11 @@ }, { "description": "Regional Endpoint", +"endpointUrl": "https://logging.sa.rep.googleapis.com/", +"location": "sa" +}, +{ +"description": "Regional Endpoint", "endpointUrl": "https://logging.us.rep.googleapis.com/", "location": "us" } @@ -636,7 +641,7 @@ ] }, "list": { -"description": "Lists information about the supported locations for this service. This method can be called in two ways: List all public locations: Use the path GET /v1/locations. List project-visible locations: Use the path GET /v1/projects/{project_id}/locations. This may include public locations as well as private or other locations specifically visible to the project.", +"description": "Lists information about the supported locations for this service.This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: Global locations: If name is empty, the method lists the public locations available to all projects. Project-specific locations: If name follows the format projects/{project}, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project.For gRPC and client library implementations, the resource name is passed as the name field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "flatPath": "v2/billingAccounts/{billingAccountsId}/locations", "httpMethod": "GET", "id": "logging.billingAccounts.locations.list", @@ -2473,7 +2478,7 @@ ] }, "list": { -"description": "Lists information about the supported locations for this service. This method can be called in two ways: List all public locations: Use the path GET /v1/locations. List project-visible locations: Use the path GET /v1/projects/{project_id}/locations. This may include public locations as well as private or other locations specifically visible to the project.", +"description": "Lists information about the supported locations for this service.This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: Global locations: If name is empty, the method lists the public locations available to all projects. Project-specific locations: If name follows the format projects/{project}, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project.For gRPC and client library implementations, the resource name is passed as the name field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "flatPath": "v2/folders/{foldersId}/locations", "httpMethod": "GET", "id": "logging.folders.locations.list", @@ -4065,7 +4070,7 @@ ] }, "list": { -"description": "Lists information about the supported locations for this service. This method can be called in two ways: List all public locations: Use the path GET /v1/locations. List project-visible locations: Use the path GET /v1/projects/{project_id}/locations. This may include public locations as well as private or other locations specifically visible to the project.", +"description": "Lists information about the supported locations for this service.This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: Global locations: If name is empty, the method lists the public locations available to all projects. Project-specific locations: If name follows the format projects/{project}, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project.For gRPC and client library implementations, the resource name is passed as the name field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "flatPath": "v2/{v2Id}/{v2Id1}/locations", "httpMethod": "GET", "id": "logging.locations.list", @@ -5313,7 +5318,7 @@ ] }, "list": { -"description": "Lists information about the supported locations for this service. This method can be called in two ways: List all public locations: Use the path GET /v1/locations. List project-visible locations: Use the path GET /v1/projects/{project_id}/locations. This may include public locations as well as private or other locations specifically visible to the project.", +"description": "Lists information about the supported locations for this service.This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: Global locations: If name is empty, the method lists the public locations available to all projects. Project-specific locations: If name follows the format projects/{project}, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project.For gRPC and client library implementations, the resource name is passed as the name field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "flatPath": "v2/organizations/{organizationsId}/locations", "httpMethod": "GET", "id": "logging.organizations.locations.list", @@ -7126,7 +7131,7 @@ ] }, "list": { -"description": "Lists information about the supported locations for this service. This method can be called in two ways: List all public locations: Use the path GET /v1/locations. List project-visible locations: Use the path GET /v1/projects/{project_id}/locations. This may include public locations as well as private or other locations specifically visible to the project.", +"description": "Lists information about the supported locations for this service.This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: Global locations: If name is empty, the method lists the public locations available to all projects. Project-specific locations: If name follows the format projects/{project}, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project.For gRPC and client library implementations, the resource name is passed as the name field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "flatPath": "v2/projects/{projectsId}/locations", "httpMethod": "GET", "id": "logging.projects.locations.list", @@ -9162,7 +9167,7 @@ } } }, -"revision": "20260315", +"revision": "20260328", "rootUrl": "https://logging.googleapis.com/", "schemas": { "AppHub": { @@ -10551,6 +10556,14 @@ "$ref": "LogEntryOperation", "description": "Optional. Information about an operation associated with the log entry, if applicable." }, +"otel": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Optional. The structured OpenTelemetry protocol payload. Contains the OpenTelemetry Resource, Instrumentation Scope, and Entities attributes for this log as they are defined in the OTLP specification, and any other fields that do not have a direct analog in the LogEntry. See https://opentelemetry.io/docs/specs/otel/logs/data-model/", +"type": "object" +}, "protoPayload": { "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", diff --git a/googleapiclient/discovery_cache/documents/looker.v1.json b/googleapiclient/discovery_cache/documents/looker.v1.json index c93801e77e..715799072b 100644 --- a/googleapiclient/discovery_cache/documents/looker.v1.json +++ b/googleapiclient/discovery_cache/documents/looker.v1.json @@ -135,7 +135,7 @@ ] }, "list": { -"description": "Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.", +"description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "flatPath": "v1/projects/{projectsId}/locations", "httpMethod": "GET", "id": "looker.projects.locations.list", @@ -715,7 +715,7 @@ } } }, -"revision": "20260216", +"revision": "20260326", "rootUrl": "https://looker.googleapis.com/", "schemas": { "AdminSettings": { @@ -975,6 +975,43 @@ }, "type": "object" }, +"IngressIpAllowlistConfig": { +"description": "Ingress IP allowlist configuration.", +"id": "IngressIpAllowlistConfig", +"properties": { +"allowlistRules": { +"description": "Optional. List of IP range rules to allow ingress traffic.", +"items": { +"$ref": "IngressIpAllowlistRule" +}, +"type": "array" +}, +"enabled": { +"description": "Optional. Whether ingress IP allowlist functionality is enabled on the Looker instance.", +"type": "boolean" +}, +"googleServicesEnabled": { +"description": "Optional. Whether google service connections are enabled for the instance.", +"type": "boolean" +} +}, +"type": "object" +}, +"IngressIpAllowlistRule": { +"description": "Ingress IP allowlist rule.", +"id": "IngressIpAllowlistRule", +"properties": { +"description": { +"description": "Optional. Description for the IP range.", +"type": "string" +}, +"ipRange": { +"description": "Optional. The IP range to allow ingress traffic from.", +"type": "string" +} +}, +"type": "object" +}, "Instance": { "description": "A Looker instance.", "id": "Instance", @@ -983,6 +1020,10 @@ "$ref": "AdminSettings", "description": "Looker Instance Admin settings." }, +"catalogIntegrationOptOut": { +"description": "Optional. Indicates whether catalog integration is disabled for the Looker instance.", +"type": "boolean" +}, "classType": { "description": "Optional. Storage class of the instance.", "enum": [ @@ -1040,6 +1081,10 @@ "description": "Optional. Whether Gemini feature is enabled on the Looker instance or not.", "type": "boolean" }, +"ingressIpAllowlistConfig": { +"$ref": "IngressIpAllowlistConfig", +"description": "Optional. Ingress IP allowlist configuration for the Looker instance." +}, "ingressPrivateIp": { "description": "Output only. Private Ingress IP (IPv4).", "readOnly": true, diff --git a/googleapiclient/discovery_cache/documents/meet.v2.json b/googleapiclient/discovery_cache/documents/meet.v2.json index 725e4eacea..1c238cb8bc 100644 --- a/googleapiclient/discovery_cache/documents/meet.v2.json +++ b/googleapiclient/discovery_cache/documents/meet.v2.json @@ -409,7 +409,11 @@ "path": "v2/{+name}", "response": { "$ref": "SmartNote" -} +}, +"scopes": [ +"https://www.googleapis.com/auth/meetings.space.created", +"https://www.googleapis.com/auth/meetings.space.readonly" +] }, "list": { "description": "Lists the set of smart notes from the conference record. By default, ordered by start time and in ascending order.", @@ -442,7 +446,11 @@ "path": "v2/{+parent}/smartNotes", "response": { "$ref": "ListSmartNotesResponse" -} +}, +"scopes": [ +"https://www.googleapis.com/auth/meetings.space.created", +"https://www.googleapis.com/auth/meetings.space.readonly" +] } } }, @@ -697,7 +705,7 @@ } } }, -"revision": "20260315", +"revision": "20260329", "rootUrl": "https://meet.googleapis.com/", "schemas": { "ActiveConference": { @@ -823,6 +831,21 @@ "properties": {}, "type": "object" }, +"GatewaySipAccess": { +"description": "Details how to join the conference via a SIP gateway.", +"id": "GatewaySipAccess", +"properties": { +"sipAccessCode": { +"description": "Permanent numeric code for manual entry on specially configured devices.", +"type": "string" +}, +"uri": { +"description": "The SIP URI the conference can be reached through. The string is on one of the formats: \"sip:@\" \"sips:@\" where currently is the 13-digit universal pin, and is a valid address to be resolved using a DNS SRV lookup, or a dotted quad.", +"type": "string" +} +}, +"type": "object" +}, "ListConferenceRecordsResponse": { "description": "Response of ListConferenceRecords method.", "id": "ListConferenceRecordsResponse", @@ -1076,6 +1099,29 @@ }, "type": "object" }, +"PhoneAccess": { +"description": "Phone access contains information required to dial into a conference using a regional phone number and a PIN that is specific to that phone number.", +"id": "PhoneAccess", +"properties": { +"languageCode": { +"description": "The BCP 47/LDML language code for the language associated with this phone access. To be parsed by the i18n LanguageCode utility. Examples: \"es-419\" for Latin American Spanish, \"fr-CA\" for Canadian French.", +"type": "string" +}, +"phoneNumber": { +"description": "The phone number to dial for this meeting space in E.164 format. Full phone number with a leading '+' character.", +"type": "string" +}, +"pin": { +"description": "The PIN that users must enter after dialing the given number. The PIN consists of only decimal digits and the length may vary.", +"type": "string" +}, +"regionCode": { +"description": "The CLDR/ISO 3166 region code for the country associated with this phone access. To be parsed by the i18n RegionCode utility. Example: \"SE\" for Sweden.", +"type": "string" +} +}, +"type": "object" +}, "PhoneUser": { "description": "User dialing in from a phone where the user's identity is unknown because they haven't signed in with a Google Account.", "id": "PhoneUser", @@ -1251,6 +1297,14 @@ "$ref": "SpaceConfig", "description": "Configuration pertaining to the meeting space." }, +"gatewaySipAccess": { +"description": "Output only. The SIP based access methods that can be used to join the conference. Can be empty.", +"items": { +"$ref": "GatewaySipAccess" +}, +"readOnly": true, +"type": "array" +}, "meetingCode": { "description": "Output only. Type friendly unique string used to join the meeting. Format: `[a-z]+-[a-z]+-[a-z]+`. For example, `abc-mnop-xyz`. The maximum length is 128 characters. Can only be used as an alias of the space name to get the space.", "readOnly": true, @@ -1264,6 +1318,14 @@ "name": { "description": "Immutable. Resource name of the space. Format: `spaces/{space}`. `{space}` is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`. For more information, see [How Meet identifies a meeting space](https://developers.google.com/workspace/meet/api/guides/meeting-spaces#identify-meeting-space).", "type": "string" +}, +"phoneAccess": { +"description": "Output only. All regional phone access methods for this meeting space. Can be empty.", +"items": { +"$ref": "PhoneAccess" +}, +"readOnly": true, +"type": "array" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/merchantapi.inventories_v1.json b/googleapiclient/discovery_cache/documents/merchantapi.inventories_v1.json index 92e17250c7..121a42e025 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.inventories_v1.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.inventories_v1.json @@ -121,7 +121,7 @@ ], "parameters": { "name": { -"description": "Required. The name of the local inventory for the given product to delete. Format: `accounts/{account}/products/{product}/localInventories/{store_code}` The `{product}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123` for `store_code` \"store123\", the `{product}` segment must be the base64url encoding of this string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name for the local inventory would be `accounts/123/products/ZW5-VVMtc2t1LzEyMw/localInventories/store123`. 2. **Plain Format**: The `{product}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product}` segment is used to differentiate between the two formats. Note: For calls to the v1beta version, the plain format for the product segment is `channel~content_language~feed_label~offer_id`. For example, the full resource name for a local inventory at `store_code` \"store123\" would be: `accounts/123/products/online~en~US~sku123/localInventories/store123`.", +"description": "Required. The name of the local inventory for the given product to delete. Format: `accounts/{account}/products/{product}/localInventories/{store_code}` The `{product}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123` for `store_code` \"store123\", the `{product}` segment must be the base64url encoding of this string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name for the local inventory would be `accounts/123/products/ZW5-VVN-c2t1LzEyMw/localInventories/store123`. 2. **Plain Format**: The `{product}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product}` segment is used to differentiate between the two formats.", "location": "path", "pattern": "^accounts/[^/]+/products/[^/]+/localInventories/[^/]+$", "required": true, @@ -146,7 +146,7 @@ ], "parameters": { "parent": { -"description": "Required. The account and product where this inventory will be inserted. Format: `accounts/{account}/products/{product}` The `{product}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{product}` segment must be the base64url encoding of this string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name for the product would be `accounts/123/products/ZW5-VVMtc2t1LzEyMw`. 2. **Plain Format**: The `{product}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product}` segment is used to differentiate between the two formats. Note: For calls to the v1beta version, the plain format is `channel~content_language~feed_label~offer_id`, for example: `accounts/123/products/online~en~US~sku123`.", +"description": "Required. The account and product where this inventory will be inserted. Format: `accounts/{account}/products/{product}` The `{product}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{product}` segment must be the base64url encoding of this string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name for the product would be `accounts/123/products/ZW5-VVN-c2t1LzEyMw`. 2. **Plain Format**: The `{product}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product}` segment is used to differentiate between the two formats.", "location": "path", "pattern": "^accounts/[^/]+/products/[^/]+$", "required": true, @@ -185,7 +185,7 @@ "type": "string" }, "parent": { -"description": "Required. The `name` of the parent product to list local inventories for. Format: `accounts/{account}/products/{product}` The `{product}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{product}` segment must be the base64url encoding of this string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name for the product would be `accounts/123/products/ZW5-VVMtc2t1LzEyMw`. 2. **Plain Format**: The `{product}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product}` segment is used to differentiate between the two formats. Note: For calls to the v1beta version, the plain format is `channel~content_language~feed_label~offer_id`, for example: `accounts/123/products/online~en~US~sku123`.", +"description": "Required. The `name` of the parent product to list local inventories for. Format: `accounts/{account}/products/{product}` The `{product}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{product}` segment must be the base64url encoding of this string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name for the product would be `accounts/123/products/ZW5-VVN-c2t1LzEyMw`. 2. **Plain Format**: The `{product}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product}` segment is used to differentiate between the two formats.", "location": "path", "pattern": "^accounts/[^/]+/products/[^/]+$", "required": true, @@ -214,7 +214,7 @@ ], "parameters": { "name": { -"description": "Required. The name of the `RegionalInventory` resource to delete. Format: `accounts/{account}/products/{product}/regionalInventories/{region}` The `{product}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123` for `region` \"region123\", the `{product}` segment must be the base64url encoding of this string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name for the regional inventory would be `accounts/123/products/ZW5-VVMtc2t1LzEyMw/regionalInventories/region123`. 2. **Plain Format**: The `{product}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product}` segment is used to differentiate between the two formats. Note: For calls to the v1beta version, the plain format for the product segment is `channel~content_language~feed_label~offer_id`. For example, the full resource name for a regional inventory in `region` \"region123\" would be: `accounts/123/products/online~en~US~sku123/regionalInventories/region123`.", +"description": "Required. The name of the `RegionalInventory` resource to delete. Format: `accounts/{account}/products/{product}/regionalInventories/{region}` The `{product}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123` for `region` \"region123\", the `{product}` segment must be the base64url encoding of this string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name for the regional inventory would be `accounts/123/products/ZW5-VVN-c2t1LzEyMw/regionalInventories/region123`. 2. **Plain Format**: The `{product}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product}` segment is used to differentiate between the two formats.", "location": "path", "pattern": "^accounts/[^/]+/products/[^/]+/regionalInventories/[^/]+$", "required": true, @@ -239,7 +239,7 @@ ], "parameters": { "parent": { -"description": "Required. The account and product where this inventory will be inserted. Format: `accounts/{account}/products/{product}` The `{product}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{product}` segment must be the base64url encoding of this string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name for the product would be `accounts/123/products/ZW5-VVMtc2t1LzEyMw`. 2. **Plain Format**: The `{product}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product}` segment is used to differentiate between the two formats. Note: For calls to the v1beta version, the plain format is `channel~content_language~feed_label~offer_id`, for example: `accounts/123/products/online~en~US~sku123`.", +"description": "Required. The account and product where this inventory will be inserted. Format: `accounts/{account}/products/{product}` The `{product}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{product}` segment must be the base64url encoding of this string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name for the product would be `accounts/123/products/ZW5-VVN-c2t1LzEyMw`. 2. **Plain Format**: The `{product}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product}` segment is used to differentiate between the two formats.", "location": "path", "pattern": "^accounts/[^/]+/products/[^/]+$", "required": true, @@ -278,7 +278,7 @@ "type": "string" }, "parent": { -"description": "Required. The `name` of the parent product to list `RegionalInventory` resources for. Format: `accounts/{account}/products/{product}` The `{product}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{product}` segment must be the base64url encoding of this string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name for the product would be `accounts/123/products/ZW5-VVMtc2t1LzEyMw`. 2. **Plain Format**: The `{product}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product}` segment is used to differentiate between the two formats. Note: For calls to the v1beta version, the plain format is `channel~content_language~feed_label~offer_id`, for example: `accounts/123/products/online~en~US~sku123`.", +"description": "Required. The `name` of the parent product to list `RegionalInventory` resources for. Format: `accounts/{account}/products/{product}` The `{product}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{product}` segment must be the base64url encoding of this string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name for the product would be `accounts/123/products/ZW5-VVN-c2t1LzEyMw`. 2. **Plain Format**: The `{product}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product}` segment is used to differentiate between the two formats.", "location": "path", "pattern": "^accounts/[^/]+/products/[^/]+$", "required": true, @@ -300,7 +300,7 @@ } } }, -"revision": "20260223", +"revision": "20260327", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "Empty": { @@ -413,7 +413,7 @@ "description": "Optional. A list of local inventory attributes." }, "name": { -"description": "Output only. The name of the `LocalInventory` resource. Format: `accounts/{account}/products/{product}/localInventories/{store_code}` The `{product}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123` for `store_code` \"store123\", the `{product}` segment must be the base64url encoding of this string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name for the local inventory would be `accounts/123/products/ZW5-VVMtc2t1LzEyMw/localInventories/store123`. 2. **Plain Format**: The `{product}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product}` segment is used to differentiate between the two formats. Note: For calls to the v1beta version, the plain format for the product segment is `channel~content_language~feed_label~offer_id`. For example, the full resource name for a local inventory at `store_code` \"store123\" would be: `accounts/123/products/online~en~US~sku123/localInventories/store123`.", +"description": "Output only. The name of the `LocalInventory` resource. Format: `accounts/{account}/products/{product}/localInventories/{store_code}` The `{product}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123` for `store_code` \"store123\", the `{product}` segment must be the base64url encoding of this string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name for the local inventory would be `accounts/123/products/ZW5-VVN-c2t1LzEyMw/localInventories/store123`. 2. **Plain Format**: The `{product}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product}` segment is used to differentiate between the two formats.", "readOnly": true, "type": "string" }, @@ -703,7 +703,7 @@ false "type": "string" }, "name": { -"description": "Output only. The name of the `RegionalInventory` resource. Format: `accounts/{account}/products/{product}/regionalInventories/{region}` The `{product}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123` for `region` \"region123\", the `{product}` segment must be the base64url encoding of this string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name for the regional inventory would be `accounts/123/products/ZW5-VVMtc2t1LzEyMw/regionalInventories/region123`. 2. **Plain Format**: The `{product}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product}` segment is used to differentiate between the two formats. Note: For calls to the v1beta version, the plain format for the product segment is `channel~content_language~feed_label~offer_id`. For example, the full resource name for a regional inventory in `region` \"region123\" would be: `accounts/123/products/online~en~US~sku123/regionalInventories/region123`.", +"description": "Output only. The name of the `RegionalInventory` resource. Format: `accounts/{account}/products/{product}/regionalInventories/{region}` The `{product}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123` for `region` \"region123\", the `{product}` segment must be the base64url encoding of this string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name for the regional inventory would be `accounts/123/products/ZW5-VVN-c2t1LzEyMw/regionalInventories/region123`. 2. **Plain Format**: The `{product}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product}` segment is used to differentiate between the two formats.", "readOnly": true, "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/merchantapi.inventories_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.inventories_v1beta.json index 4636ff976b..d327f3716c 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.inventories_v1beta.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.inventories_v1beta.json @@ -121,7 +121,7 @@ ], "parameters": { "name": { -"description": "Required. The name of the local inventory for the given product to delete. Format: `accounts/{account}/products/{product}/localInventories/{store_code}` The `{product}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123` for `store_code` \"store123\", the `{product}` segment must be the base64url encoding of this string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name for the local inventory would be `accounts/123/products/ZW5-VVMtc2t1LzEyMw/localInventories/store123`. 2. **Plain Format**: The `{product}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product}` segment is used to differentiate between the two formats. Note: For calls to the v1beta version, the plain format for the product segment is `channel~content_language~feed_label~offer_id`. For example, the full resource name for a local inventory at `store_code` \"store123\" would be: `accounts/123/products/online~en~US~sku123/localInventories/store123`.", +"description": "Required. The name of the local inventory for the given product to delete. Format: `accounts/{account}/products/{product}/localInventories/{store_code}` The `{product}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123` for `store_code` \"store123\", the `{product}` segment must be the base64url encoding of this string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name for the local inventory would be `accounts/123/products/ZW5-VVN-c2t1LzEyMw/localInventories/store123`. 2. **Plain Format**: The `{product}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product}` segment is used to differentiate between the two formats.", "location": "path", "pattern": "^accounts/[^/]+/products/[^/]+/localInventories/[^/]+$", "required": true, @@ -146,7 +146,7 @@ ], "parameters": { "parent": { -"description": "Required. The account and product where this inventory will be inserted. Format: `accounts/{account}/products/{product}` The `{product}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{product}` segment must be the base64url encoding of this string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name for the product would be `accounts/123/products/ZW5-VVMtc2t1LzEyMw`. 2. **Plain Format**: The `{product}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product}` segment is used to differentiate between the two formats. Note: For calls to the v1beta version, the plain format is `channel~content_language~feed_label~offer_id`, for example: `accounts/123/products/online~en~US~sku123`.", +"description": "Required. The account and product where this inventory will be inserted. Format: `accounts/{account}/products/{product}` The `{product}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{product}` segment must be the base64url encoding of this string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name for the product would be `accounts/123/products/ZW5-VVN-c2t1LzEyMw`. 2. **Plain Format**: The `{product}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product}` segment is used to differentiate between the two formats.", "location": "path", "pattern": "^accounts/[^/]+/products/[^/]+$", "required": true, @@ -185,7 +185,7 @@ "type": "string" }, "parent": { -"description": "Required. The `name` of the parent product to list local inventories for. Format: `accounts/{account}/products/{product}` The `{product}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{product}` segment must be the base64url encoding of this string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name for the product would be `accounts/123/products/ZW5-VVMtc2t1LzEyMw`. 2. **Plain Format**: The `{product}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product}` segment is used to differentiate between the two formats. Note: For calls to the v1beta version, the plain format is `channel~content_language~feed_label~offer_id`, for example: `accounts/123/products/online~en~US~sku123`.", +"description": "Required. The `name` of the parent product to list local inventories for. Format: `accounts/{account}/products/{product}` The `{product}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{product}` segment must be the base64url encoding of this string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name for the product would be `accounts/123/products/ZW5-VVN-c2t1LzEyMw`. 2. **Plain Format**: The `{product}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product}` segment is used to differentiate between the two formats.", "location": "path", "pattern": "^accounts/[^/]+/products/[^/]+$", "required": true, @@ -214,7 +214,7 @@ ], "parameters": { "name": { -"description": "Required. The name of the `RegionalInventory` resource to delete. Format: `accounts/{account}/products/{product}/regionalInventories/{region}` The `{product}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123` for `region` \"region123\", the `{product}` segment must be the base64url encoding of this string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name for the regional inventory would be `accounts/123/products/ZW5-VVMtc2t1LzEyMw/regionalInventories/region123`. 2. **Plain Format**: The `{product}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product}` segment is used to differentiate between the two formats. Note: For calls to the v1beta version, the plain format for the product segment is `channel~content_language~feed_label~offer_id`. For example, the full resource name for a regional inventory in `region` \"region123\" would be: `accounts/123/products/online~en~US~sku123/regionalInventories/region123`.", +"description": "Required. The name of the `RegionalInventory` resource to delete. Format: `accounts/{account}/products/{product}/regionalInventories/{region}` The `{product}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123` for `region` \"region123\", the `{product}` segment must be the base64url encoding of this string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name for the regional inventory would be `accounts/123/products/ZW5-VVN-c2t1LzEyMw/regionalInventories/region123`. 2. **Plain Format**: The `{product}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product}` segment is used to differentiate between the two formats.", "location": "path", "pattern": "^accounts/[^/]+/products/[^/]+/regionalInventories/[^/]+$", "required": true, @@ -239,7 +239,7 @@ ], "parameters": { "parent": { -"description": "Required. The account and product where this inventory will be inserted. Format: `accounts/{account}/products/{product}` The `{product}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{product}` segment must be the base64url encoding of this string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name for the product would be `accounts/123/products/ZW5-VVMtc2t1LzEyMw`. 2. **Plain Format**: The `{product}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product}` segment is used to differentiate between the two formats. Note: For calls to the v1beta version, the plain format is `channel~content_language~feed_label~offer_id`, for example: `accounts/123/products/online~en~US~sku123`.", +"description": "Required. The account and product where this inventory will be inserted. Format: `accounts/{account}/products/{product}` The `{product}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{product}` segment must be the base64url encoding of this string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name for the product would be `accounts/123/products/ZW5-VVN-c2t1LzEyMw`. 2. **Plain Format**: The `{product}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product}` segment is used to differentiate between the two formats.", "location": "path", "pattern": "^accounts/[^/]+/products/[^/]+$", "required": true, @@ -278,7 +278,7 @@ "type": "string" }, "parent": { -"description": "Required. The `name` of the parent product to list `RegionalInventory` resources for. Format: `accounts/{account}/products/{product}` The `{product}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{product}` segment must be the base64url encoding of this string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name for the product would be `accounts/123/products/ZW5-VVMtc2t1LzEyMw`. 2. **Plain Format**: The `{product}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product}` segment is used to differentiate between the two formats. Note: For calls to the v1beta version, the plain format is `channel~content_language~feed_label~offer_id`, for example: `accounts/123/products/online~en~US~sku123`.", +"description": "Required. The `name` of the parent product to list `RegionalInventory` resources for. Format: `accounts/{account}/products/{product}` The `{product}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{product}` segment must be the base64url encoding of this string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name for the product would be `accounts/123/products/ZW5-VVN-c2t1LzEyMw`. 2. **Plain Format**: The `{product}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product}` segment is used to differentiate between the two formats.", "location": "path", "pattern": "^accounts/[^/]+/products/[^/]+$", "required": true, @@ -300,7 +300,7 @@ } } }, -"revision": "20260223", +"revision": "20260327", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "CustomAttribute": { @@ -411,7 +411,7 @@ "type": "string" }, "name": { -"description": "Output only. The name of the `LocalInventory` resource. Format: `accounts/{account}/products/{product}/localInventories/{store_code}` The `{product}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123` for `store_code` \"store123\", the `{product}` segment must be the base64url encoding of this string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name for the local inventory would be `accounts/123/products/ZW5-VVMtc2t1LzEyMw/localInventories/store123`. 2. **Plain Format**: The `{product}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product}` segment is used to differentiate between the two formats. Note: For calls to the v1beta version, the plain format for the product segment is `channel~content_language~feed_label~offer_id`. For example, the full resource name for a local inventory at `store_code` \"store123\" would be: `accounts/123/products/online~en~US~sku123/localInventories/store123`.", +"description": "Output only. The name of the `LocalInventory` resource. Format: `accounts/{account}/products/{product}/localInventories/{store_code}` The `{product}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123` for `store_code` \"store123\", the `{product}` segment must be the base64url encoding of this string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name for the local inventory would be `accounts/123/products/ZW5-VVN-c2t1LzEyMw/localInventories/store123`. 2. **Plain Format**: The `{product}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product}` segment is used to differentiate between the two formats.", "readOnly": true, "type": "string" }, @@ -639,7 +639,7 @@ false "type": "array" }, "name": { -"description": "Output only. The name of the `RegionalInventory` resource. Format: `accounts/{account}/products/{product}/regionalInventories/{region}` The `{product}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123` for `region` \"region123\", the `{product}` segment must be the base64url encoding of this string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name for the regional inventory would be `accounts/123/products/ZW5-VVMtc2t1LzEyMw/regionalInventories/region123`. 2. **Plain Format**: The `{product}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product}` segment is used to differentiate between the two formats. Note: For calls to the v1beta version, the plain format for the product segment is `channel~content_language~feed_label~offer_id`. For example, the full resource name for a regional inventory in `region` \"region123\" would be: `accounts/123/products/online~en~US~sku123/regionalInventories/region123`.", +"description": "Output only. The name of the `RegionalInventory` resource. Format: `accounts/{account}/products/{product}/regionalInventories/{region}` The `{product}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123` for `region` \"region123\", the `{product}` segment must be the base64url encoding of this string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name for the regional inventory would be `accounts/123/products/ZW5-VVN-c2t1LzEyMw/regionalInventories/region123`. 2. **Plain Format**: The `{product}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product}` segment is used to differentiate between the two formats.", "readOnly": true, "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/merchantapi.issueresolution_v1.json b/googleapiclient/discovery_cache/documents/merchantapi.issueresolution_v1.json index 466a3e2f10..c58741e987 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.issueresolution_v1.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.issueresolution_v1.json @@ -209,7 +209,7 @@ "type": "string" }, "name": { -"description": "Required. The name of the product. Format: `accounts/{account}/products/{product}` The `{product}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{product}` segment must be the base64url encoding of this string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name for the product would be `accounts/123/products/ZW5-VVMtc2t1LzEyMw`. 2. **Plain Format**: The `{product}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product}` segment is used to differentiate between the two formats. Note: For calls to the v1beta version, the plain format is `channel~content_language~feed_label~offer_id`, for example: `accounts/123/products/online~en~US~sku123`.", +"description": "Required. The name of the product. Format: `accounts/{account}/products/{product}` The `{product}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{product}` segment must be the base64url encoding of this string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name for the product would be `accounts/123/products/ZW5-VVN-c2t1LzEyMw`. 2. **Plain Format**: The `{product}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product}` segment is used to differentiate between the two formats.", "location": "path", "pattern": "^accounts/[^/]+/products/[^/]+$", "required": true, @@ -268,7 +268,7 @@ } } }, -"revision": "20260223", +"revision": "20260327", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "Action": { diff --git a/googleapiclient/discovery_cache/documents/merchantapi.issueresolution_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.issueresolution_v1beta.json index 3b2310da4d..e94f9e665b 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.issueresolution_v1beta.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.issueresolution_v1beta.json @@ -209,7 +209,7 @@ "type": "string" }, "name": { -"description": "Required. The name of the product. Format: `accounts/{account}/products/{product}` The `{product}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{product}` segment must be the base64url encoding of this string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name for the product would be `accounts/123/products/ZW5-VVMtc2t1LzEyMw`. 2. **Plain Format**: The `{product}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product}` segment is used to differentiate between the two formats. Note: For calls to the v1beta version, the plain format is `channel~content_language~feed_label~offer_id`, for example: `accounts/123/products/online~en~US~sku123`.", +"description": "Required. The name of the product. Format: `accounts/{account}/products/{product}` The `{product}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{product}` segment must be the base64url encoding of this string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name for the product would be `accounts/123/products/ZW5-VVN-c2t1LzEyMw`. 2. **Plain Format**: The `{product}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product}` segment is used to differentiate between the two formats.", "location": "path", "pattern": "^accounts/[^/]+/products/[^/]+$", "required": true, @@ -268,7 +268,7 @@ } } }, -"revision": "20260223", +"revision": "20260327", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "Action": { diff --git a/googleapiclient/discovery_cache/documents/merchantapi.products_v1.json b/googleapiclient/discovery_cache/documents/merchantapi.products_v1.json index a4acce561d..e6fac6f937 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.products_v1.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.products_v1.json @@ -124,7 +124,7 @@ "type": "string" }, "name": { -"description": "Required. The name of the product input to delete. Format: `accounts/{account}/productInputs/{productInput}` The {productInput} segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the {productInput} segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{productInput}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{productInput}` segment must be the base64url encoding of this string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name for the product would be `accounts/123/productInputs/ZW5-VVMtc2t1LzEyMw`. 2. **Plain Format**: The `{productInput}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{productInput}` segment is used to differentiate between the two formats. Note: For calls to the v1beta version, the plain format is `channel~content_language~feed_label~offer_id`, for example: `accounts/123/productinputs/online~en~US~sku123`.", +"description": "Required. The name of the product input to delete. Format: `accounts/{account}/productInputs/{productInput}` The {productInput} segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the {productInput} segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{productInput}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{productInput}` segment must be the base64url encoding of this string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name for the product would be `accounts/123/productInputs/ZW5-VVN-c2t1LzEyMw`. 2. **Plain Format**: The `{productInput}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{productInput}` segment is used to differentiate between the two formats.", "location": "path", "pattern": "^accounts/[^/]+/productInputs/[^/]+$", "required": true, @@ -187,7 +187,7 @@ "type": "string" }, "name": { -"description": "Identifier. The name of the product. Format: `accounts/{account}/productInputs/{productinput}` The {productinput} segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the {productinput} segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{productinput}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{productinput}` segment must be the base64url encoding of this string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name for the product would be `accounts/123/productinputs/ZW5-VVMtc2t1LzEyMw`. 2. **Plain Format**: The `{productinput}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{productinput}` segment is used to differentiate between the two formats. Note: For calls to the v1beta version, the plain format is `channel~content_language~feed_label~offer_id`, for example: `accounts/123/productinputs/online~en~US~sku123`.", +"description": "Identifier. The name of the product. Format: `accounts/{account}/productInputs/{productinput}` The {productinput} segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the {productinput} segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{productinput}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{productinput}` segment must be the base64url encoding of this string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name for the product would be `accounts/123/productInputs/ZW5-VVN-c2t1LzEyMw`. 2. **Plain Format**: The `{productinput}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{productinput}` segment is used to differentiate between the two formats.", "location": "path", "pattern": "^accounts/[^/]+/productInputs/[^/]+$", "required": true, @@ -281,7 +281,7 @@ } } }, -"revision": "20260326", +"revision": "20260327", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "AutomatedDiscounts": { @@ -2053,7 +2053,7 @@ false "type": "boolean" }, "name": { -"description": "Identifier. The name of the product. Format: `accounts/{account}/productInputs/{productinput}` The {productinput} segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the {productinput} segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{productinput}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{productinput}` segment must be the base64url encoding of this string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name for the product would be `accounts/123/productinputs/ZW5-VVMtc2t1LzEyMw`. 2. **Plain Format**: The `{productinput}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{productinput}` segment is used to differentiate between the two formats. Note: For calls to the v1beta version, the plain format is `channel~content_language~feed_label~offer_id`, for example: `accounts/123/productinputs/online~en~US~sku123`.", +"description": "Identifier. The name of the product. Format: `accounts/{account}/productInputs/{productinput}` The {productinput} segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the {productinput} segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{productinput}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{productinput}` segment must be the base64url encoding of this string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name for the product would be `accounts/123/productInputs/ZW5-VVN-c2t1LzEyMw`. 2. **Plain Format**: The `{productinput}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{productinput}` segment is used to differentiate between the two formats.", "type": "string" }, "offerId": { diff --git a/googleapiclient/discovery_cache/documents/merchantapi.products_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.products_v1beta.json index a1cbd3be94..f47e7edef5 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.products_v1beta.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.products_v1beta.json @@ -124,7 +124,7 @@ "type": "string" }, "name": { -"description": "Required. The name of the product input to delete. Format: `accounts/{account}/productInputs/{productInput}` The {productInput} segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the {productInput} segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{productInput}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{productInput}` segment must be the base64url encoding of this string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name for the product would be `accounts/123/productInputs/ZW5-VVMtc2t1LzEyMw`. 2. **Plain Format**: The `{productInput}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{productInput}` segment is used to differentiate between the two formats. Note: For calls to the v1beta version, the plain format is `channel~content_language~feed_label~offer_id`, for example: `accounts/123/productinputs/online~en~US~sku123`.", +"description": "Required. The name of the product input to delete. Format: `accounts/{account}/productInputs/{productInput}` The {productInput} segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the {productInput} segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{productInput}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{productInput}` segment must be the base64url encoding of this string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name for the product would be `accounts/123/productInputs/ZW5-VVN-c2t1LzEyMw`. 2. **Plain Format**: The `{productInput}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{productInput}` segment is used to differentiate between the two formats.", "location": "path", "pattern": "^accounts/[^/]+/productInputs/[^/]+$", "required": true, @@ -187,7 +187,7 @@ "type": "string" }, "name": { -"description": "Identifier. The name of the product. Format: `accounts/{account}/productInputs/{productinput}` The {productinput} segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the {productinput} segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{productinput}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{productinput}` segment must be the base64url encoding of this string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name for the product would be `accounts/123/productinputs/ZW5-VVMtc2t1LzEyMw`. 2. **Plain Format**: The `{productinput}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{productinput}` segment is used to differentiate between the two formats. Note: For calls to the v1beta version, the plain format is `channel~content_language~feed_label~offer_id`, for example: `accounts/123/productinputs/online~en~US~sku123`.", +"description": "Identifier. The name of the product. Format: `accounts/{account}/productInputs/{productinput}` The {productinput} segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the {productinput} segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{productinput}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{productinput}` segment must be the base64url encoding of this string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name for the product would be `accounts/123/productInputs/ZW5-VVN-c2t1LzEyMw`. 2. **Plain Format**: The `{productinput}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{productinput}` segment is used to differentiate between the two formats.", "location": "path", "pattern": "^accounts/[^/]+/productInputs/[^/]+$", "required": true, @@ -281,7 +281,7 @@ } } }, -"revision": "20260326", +"revision": "20260327", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "Attributes": { @@ -1473,7 +1473,7 @@ false "type": "string" }, "name": { -"description": "Identifier. The name of the product. Format: `accounts/{account}/productInputs/{productinput}` The {productinput} segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the {productinput} segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{productinput}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{productinput}` segment must be the base64url encoding of this string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name for the product would be `accounts/123/productinputs/ZW5-VVMtc2t1LzEyMw`. 2. **Plain Format**: The `{productinput}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{productinput}` segment is used to differentiate between the two formats. Note: For calls to the v1beta version, the plain format is `channel~content_language~feed_label~offer_id`, for example: `accounts/123/productinputs/online~en~US~sku123`.", +"description": "Identifier. The name of the product. Format: `accounts/{account}/productInputs/{productinput}` The {productinput} segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the {productinput} segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{productinput}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{productinput}` segment must be the base64url encoding of this string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name for the product would be `accounts/123/productInputs/ZW5-VVN-c2t1LzEyMw`. 2. **Plain Format**: The `{productinput}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{productinput}` segment is used to differentiate between the two formats.", "type": "string" }, "offerId": { diff --git a/googleapiclient/discovery_cache/documents/migrationcenter.v1.json b/googleapiclient/discovery_cache/documents/migrationcenter.v1.json index 312c7fd2a1..5d34d1dfc4 100644 --- a/googleapiclient/discovery_cache/documents/migrationcenter.v1.json +++ b/googleapiclient/discovery_cache/documents/migrationcenter.v1.json @@ -160,7 +160,7 @@ ] }, "list": { -"description": "Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.", +"description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "flatPath": "v1/projects/{projectsId}/locations", "httpMethod": "GET", "id": "migrationcenter.projects.locations.list", @@ -2568,7 +2568,7 @@ } } }, -"revision": "20260126", +"revision": "20260326", "rootUrl": "https://migrationcenter.googleapis.com/", "schemas": { "AddAssetsToGroupRequest": { diff --git a/googleapiclient/discovery_cache/documents/mybusinessbusinessinformation.v1.json b/googleapiclient/discovery_cache/documents/mybusinessbusinessinformation.v1.json index 978550bc61..db0bde5da1 100644 --- a/googleapiclient/discovery_cache/documents/mybusinessbusinessinformation.v1.json +++ b/googleapiclient/discovery_cache/documents/mybusinessbusinessinformation.v1.json @@ -487,7 +487,7 @@ } }, "getGoogleUpdated": { -"description": "Gets the Google-updated version of the specified location.", +"description": "Gets the version of the specified location, returning a `GoogleUpdatedLocation` that provides the location view as it appears to consumers and masks indicating which fields are different than the merchant's information.", "flatPath": "v1/locations/{locationsId}:getGoogleUpdated", "httpMethod": "GET", "id": "mybusinessbusinessinformation.locations.getGoogleUpdated", @@ -586,7 +586,7 @@ "attributes": { "methods": { "getGoogleUpdated": { -"description": "Gets the Google-updated version of the specified location.", +"description": "Gets the version of the specified location, returning an `Attributes` message that provides the attributes view as it appears to consumers, which may be different than the merchant's information.", "flatPath": "v1/locations/{locationsId}/attributes:getGoogleUpdated", "httpMethod": "GET", "id": "mybusinessbusinessinformation.locations.attributes.getGoogleUpdated", @@ -612,7 +612,7 @@ } } }, -"revision": "20250723", +"revision": "20260405", "rootUrl": "https://mybusinessbusinessinformation.googleapis.com/", "schemas": { "AdWordsLocationExtensions": { @@ -922,7 +922,7 @@ "type": "object" }, "FreeFormServiceItem": { -"description": "Represents a free-form service offered by the merchant. These are services that are not exposed as part of our structure service data. The merchant manually enters the names for of such services via a geomerchant surface.", +"description": "Represents a free-form service offered by the merchant. These are services that are not exposed as part of our structure service data. The merchant manually enters the names for such services using a geomerchant surface.", "id": "FreeFormServiceItem", "properties": { "category": { @@ -931,7 +931,7 @@ }, "label": { "$ref": "Label", -"description": "Required. Language-tagged labels for the item. We recommend that item names be 140 characters or less, and descriptions 250 characters or less. This field should only be set if the input is a custom service item. Standardized service types should be updated via service_type_id." +"description": "Required. Language-tagged labels for the item. We recommend that item names be 140 characters or less, and descriptions 250 characters or less. This field should only be set if the input is a custom service item. Standardized service types should be updated using service_type_id." } }, "type": "object" @@ -956,11 +956,11 @@ "type": "object" }, "GoogleUpdatedLocation": { -"description": "Represents a location that was modified by Google.", +"description": "Represents the view of a location as it appears to consumers, which includes updates that are currently serving on Google Maps and Search.", "id": "GoogleUpdatedLocation", "properties": { "diffMask": { -"description": "The fields that Google updated.", +"description": "The fields where the values in the view as it appears to consumers are different than the merchant's information. To accept these changes, patch the location. To reject, patch with your preferred values.", "format": "google-fieldmask", "type": "string" }, @@ -969,7 +969,7 @@ "description": "The Google-updated version of this location." }, "pendingMask": { -"description": "The fields that have pending edits that haven't yet been pushed to Maps and Search.", +"description": "The fields where the merchant has provided an update that is currently in flight and hasn't yet been published to Maps and Search. This mask only tracks the status of the merchant's own edits, not external changes.", "format": "google-fieldmask", "type": "string" } @@ -1214,7 +1214,7 @@ "type": "string" }, "hasGoogleUpdated": { -"description": "Output only. Indicates whether the place ID associated with this location has updates that need to be updated or rejected by the client. If this boolean is set, you should call the `getGoogleUpdated` method to lookup information that's needs to be verified.", +"description": "Output only. Indicates whether the place ID associated with this location has updates that need to be updated or rejected by the client. If this boolean is set, you should call the `getGoogleUpdated` method to look up information that's needs to be verified.", "readOnly": true, "type": "boolean" }, diff --git a/googleapiclient/discovery_cache/documents/netapp.v1.json b/googleapiclient/discovery_cache/documents/netapp.v1.json index 03642d171d..82d400a2ec 100644 --- a/googleapiclient/discovery_cache/documents/netapp.v1.json +++ b/googleapiclient/discovery_cache/documents/netapp.v1.json @@ -2827,7 +2827,7 @@ } } }, -"revision": "20260326", +"revision": "20260402", "rootUrl": "https://netapp.googleapis.com/", "schemas": { "ActiveDirectory": { @@ -4051,6 +4051,18 @@ }, "type": "object" }, +"LargeCapacityConfig": { +"description": "Configuration for a Large Capacity Volume. A Large Capacity Volume supports sizes ranging from 4.8 TiB to 20 PiB, it is composed of multiple internal constituents, and must be created in a large capacity pool.", +"id": "LargeCapacityConfig", +"properties": { +"constituentCount": { +"description": "Optional. The number of internal constituents (e.g., FlexVols) for this large volume. The minimum number of constituents is 2.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, "ListActiveDirectoriesResponse": { "description": "ListActiveDirectoriesResponse contains all the active directories requested.", "id": "ListActiveDirectoriesResponse", @@ -5283,6 +5295,20 @@ "readOnly": true, "type": "boolean" }, +"scaleType": { +"description": "Optional. The scale type of the storage pool. Defaults to `SCALE_TYPE_DEFAULT` if not specified.", +"enum": [ +"SCALE_TYPE_UNSPECIFIED", +"SCALE_TYPE_DEFAULT", +"SCALE_TYPE_SCALEOUT" +], +"enumDescriptions": [ +"Unspecified scale type.", +"Represents standard capacity and performance scale-type. Suitable for general purpose workloads.", +"Represents higher capacity and performance scale-type. Suitable for more demanding workloads." +], +"type": "string" +}, "serviceLevel": { "description": "Required. Service level of the storage pool", "enum": [ @@ -5625,9 +5651,13 @@ "type": "object" }, "largeCapacity": { -"description": "Optional. Flag indicating if the volume will be a large capacity volume or a regular volume.", +"description": "Optional. Flag indicating if the volume will be a large capacity volume or a regular volume. This field is used for legacy FILE pools. For Unified pools, use the `large_capacity_config` field instead. This field and `large_capacity_config` are mutually exclusive.", "type": "boolean" }, +"largeCapacityConfig": { +"$ref": "LargeCapacityConfig", +"description": "Optional. Large capacity config for the volume. Enables and configures large capacity for volumes in Unified pools with File protocols. Not applicable for Block protocols in Unified pools. This field and the legacy `large_capacity` boolean field are mutually exclusive." +}, "ldapEnabled": { "description": "Output only. Flag indicating if the volume is NFS LDAP enabled or not.", "readOnly": true, diff --git a/googleapiclient/discovery_cache/documents/netapp.v1beta1.json b/googleapiclient/discovery_cache/documents/netapp.v1beta1.json index 287af6260d..9bfd9d7014 100644 --- a/googleapiclient/discovery_cache/documents/netapp.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/netapp.v1beta1.json @@ -2827,7 +2827,7 @@ } } }, -"revision": "20260326", +"revision": "20260402", "rootUrl": "https://netapp.googleapis.com/", "schemas": { "ActiveDirectory": { @@ -5323,8 +5323,8 @@ ], "enumDescriptions": [ "Unspecified scale type.", -"The standard capacity and performance scale-type. Suitable for general purpose workloads.", -"A higher scale-type. Suitable for more demanding workloads." +"Represents standard capacity and performance scale-type. Suitable for general purpose workloads.", +"Represents higher capacity and performance scale-type. Suitable for more demanding workloads." ], "type": "string" }, @@ -5670,12 +5670,12 @@ "type": "object" }, "largeCapacity": { -"description": "Optional. Flag indicating if the volume will be a large capacity volume or a regular volume.", +"description": "Optional. Flag indicating if the volume will be a large capacity volume or a regular volume. This field is used for legacy FILE pools. For Unified pools, use the `large_capacity_config` field instead. This field and `large_capacity_config` are mutually exclusive.", "type": "boolean" }, "largeCapacityConfig": { "$ref": "LargeCapacityConfig", -"description": "Optional. Large capacity config for the volume." +"description": "Optional. Large capacity config for the volume. Enables and configures large capacity for volumes in Unified pools with File protocols. Not applicable for Block protocols in Unified pools. This field and the legacy `large_capacity` boolean field are mutually exclusive." }, "ldapEnabled": { "description": "Output only. Flag indicating if the volume is NFS LDAP enabled or not.", diff --git a/googleapiclient/discovery_cache/documents/networkmanagement.v1.json b/googleapiclient/discovery_cache/documents/networkmanagement.v1.json index c735da2e32..7ff2185a6e 100644 --- a/googleapiclient/discovery_cache/documents/networkmanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/networkmanagement.v1.json @@ -135,7 +135,7 @@ ] }, "list": { -"description": "Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.", +"description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "flatPath": "v1/organizations/{organizationsId}/locations", "httpMethod": "GET", "id": "networkmanagement.organizations.locations.list", @@ -516,7 +516,7 @@ ] }, "list": { -"description": "Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.", +"description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "flatPath": "v1/projects/{projectsId}/locations", "httpMethod": "GET", "id": "networkmanagement.projects.locations.list", @@ -1237,7 +1237,7 @@ } } }, -"revision": "20260225", +"revision": "20260327", "rootUrl": "https://networkmanagement.googleapis.com/", "schemas": { "AbortInfo": { diff --git a/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json b/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json index 9939fdd859..895a734e85 100644 --- a/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json @@ -135,7 +135,7 @@ ] }, "list": { -"description": "Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.", +"description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "flatPath": "v1beta1/organizations/{organizationsId}/locations", "httpMethod": "GET", "id": "networkmanagement.organizations.locations.list", @@ -516,7 +516,7 @@ ] }, "list": { -"description": "Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.", +"description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "flatPath": "v1beta1/projects/{projectsId}/locations", "httpMethod": "GET", "id": "networkmanagement.projects.locations.list", @@ -1237,7 +1237,7 @@ } } }, -"revision": "20260225", +"revision": "20260327", "rootUrl": "https://networkmanagement.googleapis.com/", "schemas": { "AbortInfo": { diff --git a/googleapiclient/discovery_cache/documents/networksecurity.v1.json b/googleapiclient/discovery_cache/documents/networksecurity.v1.json index 1a683d26e9..6bba2b416e 100644 --- a/googleapiclient/discovery_cache/documents/networksecurity.v1.json +++ b/googleapiclient/discovery_cache/documents/networksecurity.v1.json @@ -1074,7 +1074,7 @@ ] }, "list": { -"description": "Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.", +"description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "flatPath": "v1/projects/{projectsId}/locations", "httpMethod": "GET", "id": "networksecurity.projects.locations.list", @@ -5237,7 +5237,7 @@ } } }, -"revision": "20260226", +"revision": "20260323", "rootUrl": "https://networksecurity.googleapis.com/", "schemas": { "AddAddressGroupItemsRequest": { @@ -5496,6 +5496,20 @@ "description": "Required. Identifier. Name of the `AuthzPolicy` resource in the following format: `projects/{project}/locations/{location}/authzPolicies/{authz_policy}`.", "type": "string" }, +"policyProfile": { +"description": "Optional. Immutable. Defines the type of authorization being performed. If not specified, `REQUEST_AUTHZ` is applied. This field cannot be changed once AuthzPolicy is created.", +"enum": [ +"POLICY_PROFILE_UNSPECIFIED", +"REQUEST_AUTHZ", +"CONTENT_AUTHZ" +], +"enumDescriptions": [ +"Unspecified policy profile.", +"Applies to request authorization. `CUSTOM` authorization policies with Authz extensions will be allowed with `EXT_AUTHZ_GRPC` or `EXT_PROC_GRPC` protocols. Extensions are invoked only for request header events.", +"Applies to content security, sanitization, etc. Only `CUSTOM` action is allowed in this policy profile. AuthzExtensions in the custom provider must support `EXT_PROC_GRPC` protocol only and be capable of receiving all `EXT_PROC_GRPC` events (REQUEST_HEADERS, REQUEST_BODY, REQUEST_TRAILERS, RESPONSE_HEADERS, RESPONSE_BODY, RESPONSE_TRAILERS) with `FULL_DUPLEX_STREAMED` body send mode." +], +"type": "string" +}, "target": { "$ref": "AuthzPolicyTarget", "description": "Required. Specifies the set of resources to which this policy should be applied to." @@ -5728,6 +5742,10 @@ }, "type": "array" }, +"mcp": { +"$ref": "AuthzPolicyAuthzRuleToRequestOperationMCP", +"description": "Optional. Defines the MCP protocol attributes to match on. If the MCP payload in the request body cannot be successfully parsed, the request will be denied. This field can be set only for AuthzPolicies targeting AgentGateway resources." +}, "methods": { "description": "Optional. A list of HTTP methods to match against. Each entry must be a valid HTTP method name (GET, PUT, POST, HEAD, PATCH, DELETE, OPTIONS). It only allows exact match and is always case sensitive. Limited to 10 methods per Authorization Policy.", "items": { @@ -5759,6 +5777,52 @@ }, "type": "object" }, +"AuthzPolicyAuthzRuleToRequestOperationMCP": { +"description": "Describes a set of MCP protocol attributes to match against for a given MCP request.", +"id": "AuthzPolicyAuthzRuleToRequestOperationMCP", +"properties": { +"baseProtocolMethodsOption": { +"description": "Optional. If specified, matches on the MCP protocol\u2019s non-access specific methods namely: * initialize * completion/ * logging/ * notifications/ * ping Defaults to SKIP_BASE_PROTOCOL_METHODS if not specified.", +"enum": [ +"BASE_PROTOCOL_METHODS_OPTION_UNSPECIFIED", +"SKIP_BASE_PROTOCOL_METHODS", +"MATCH_BASE_PROTOCOL_METHODS" +], +"enumDescriptions": [ +"Unspecified option. Defaults to SKIP_BASE_PROTOCOL_METHODS.", +"Skip matching on the base MCP protocol methods.", +"Match on the base MCP protocol methods." +], +"type": "string" +}, +"methods": { +"description": "Optional. A list of MCP methods and associated parameters to match on. It is recommended to use this field to match on tools, prompts and resource accesses while setting the baseProtocolMethodsOption to MATCH_BASE_PROTOCOL_METHODS to match on all the other MCP protocol methods. Limited to 10 MCP methods per Authorization Policy.", +"items": { +"$ref": "AuthzPolicyAuthzRuleToRequestOperationMCPMethod" +}, +"type": "array" +} +}, +"type": "object" +}, +"AuthzPolicyAuthzRuleToRequestOperationMCPMethod": { +"description": "Describes a set of MCP methods to match against.", +"id": "AuthzPolicyAuthzRuleToRequestOperationMCPMethod", +"properties": { +"name": { +"description": "Required. The MCP method to match against. Allowed values are as follows: 1. `tools`, `prompts`, `resources` - these will match against all sub methods under the respective methods. 2. `prompts/list`, `tools/list`, `resources/list`, `resources/templates/list` 3. `prompts/get`, `tools/call`, `resources/subscribe`, `resources/unsubscribe`, `resources/read` Params cannot be specified for categories 1 and 2.", +"type": "string" +}, +"params": { +"description": "Optional. A list of MCP method parameters to match against. The match can be one of exact, prefix, suffix, or contains (substring match). Matches are always case sensitive unless the ignoreCase is set. Limited to 10 MCP method parameters per Authorization Policy.", +"items": { +"$ref": "AuthzPolicyAuthzRuleStringMatch" +}, +"type": "array" +} +}, +"type": "object" +}, "AuthzPolicyCustomProvider": { "description": "Allows delegating authorization decisions to Cloud IAP or to Service Extensions.", "id": "AuthzPolicyCustomProvider", @@ -5799,7 +5863,7 @@ "id": "AuthzPolicyTarget", "properties": { "loadBalancingScheme": { -"description": "Required. All gateways and forwarding rules referenced by this policy and extensions must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED` and `EXTERNAL_MANAGED`. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service).", +"description": "Optional. All gateways and forwarding rules referenced by this policy and extensions must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED` and `EXTERNAL_MANAGED`. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service).", "enum": [ "LOAD_BALANCING_SCHEME_UNSPECIFIED", "INTERNAL_MANAGED", @@ -6121,7 +6185,7 @@ "type": "array" }, "billingProjectId": { -"description": "Required. Project to bill on endpoint uptime usage.", +"description": "Optional. Project to charge for the deployed firewall endpoint. This field must be specified when creating the endpoint in the organization scope, and should be omitted otherwise.", "type": "string" }, "createTime": { @@ -6894,6 +6958,12 @@ "description": "Required. Immutable. The VPC network that is associated. for example: `projects/123456789/global/networks/my-network`. See https://google.aip.dev/124.", "type": "string" }, +"networkCookie": { +"description": "Output only. Identifier used by the data-path. See the NSI GENEVE format for more details: https://docs.cloud.google.com/network-security-integration/docs/understand-geneve#network_id", +"format": "uint32", +"readOnly": true, +"type": "integer" +}, "reconciling": { "description": "Output only. The current state of the resource does not match the user's intended state, and the system is working to reconcile them. This part of the normal operation (e.g. adding a new location to the target deployment group). See https://google.aip.dev/128.", "readOnly": true, diff --git a/googleapiclient/discovery_cache/documents/networkservices.v1.json b/googleapiclient/discovery_cache/documents/networkservices.v1.json index 63e8cbf783..bf89a4682d 100644 --- a/googleapiclient/discovery_cache/documents/networkservices.v1.json +++ b/googleapiclient/discovery_cache/documents/networkservices.v1.json @@ -3191,7 +3191,7 @@ } } }, -"revision": "20260319", +"revision": "20260330", "rootUrl": "https://networkservices.googleapis.com/", "schemas": { "AuditConfig": { @@ -3673,6 +3673,10 @@ }, "type": "array" }, +"allPorts": { +"description": "Optional. If true, the Gateway will listen on all ports. This is mutually exclusive with the `ports` field. This field only applies to gateways of type 'SECURE_WEB_GATEWAY'.", +"type": "boolean" +}, "allowGlobalAccess": { "description": "Optional. If true, the gateway will allow traffic from clients outside of the region where the gateway is located. This field is configurable only for gateways of type SECURE_WEB_GATEWAY.", "type": "boolean" diff --git a/googleapiclient/discovery_cache/documents/networkservices.v1beta1.json b/googleapiclient/discovery_cache/documents/networkservices.v1beta1.json index 00cd1c88c8..885162675c 100644 --- a/googleapiclient/discovery_cache/documents/networkservices.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/networkservices.v1beta1.json @@ -3100,7 +3100,7 @@ } } }, -"revision": "20260319", +"revision": "20260330", "rootUrl": "https://networkservices.googleapis.com/", "schemas": { "AuthzExtension": { @@ -3454,6 +3454,10 @@ }, "type": "array" }, +"allPorts": { +"description": "Optional. If true, the Gateway will listen on all ports. This is mutually exclusive with the `ports` field. This field only applies to gateways of type 'SECURE_WEB_GATEWAY'.", +"type": "boolean" +}, "allowGlobalAccess": { "description": "Optional. If true, the gateway will allow traffic from clients outside of the region where the gateway is located. This field is configurable only for gateways of type SECURE_WEB_GATEWAY.", "type": "boolean" diff --git a/googleapiclient/discovery_cache/documents/ondemandscanning.v1.json b/googleapiclient/discovery_cache/documents/ondemandscanning.v1.json index ae2f9ac564..a1a4864ac9 100644 --- a/googleapiclient/discovery_cache/documents/ondemandscanning.v1.json +++ b/googleapiclient/discovery_cache/documents/ondemandscanning.v1.json @@ -344,9 +344,27 @@ } } }, -"revision": "20260323", +"revision": "20260330", "rootUrl": "https://ondemandscanning.googleapis.com/", "schemas": { +"AISkillAnalysisOccurrence": { +"description": "AISkillAnalysisOccurrence provides the results of an AI-based skill analysis.", +"id": "AISkillAnalysisOccurrence", +"properties": { +"findings": { +"description": "Findings produced by the analysis.", +"items": { +"$ref": "Finding" +}, +"type": "array" +}, +"skillName": { +"description": "Name of the skill that produced this analysis.", +"type": "string" +} +}, +"type": "object" +}, "AliasContext": { "description": "An alias to a repo revision.", "id": "AliasContext", @@ -1263,6 +1281,41 @@ }, "type": "object" }, +"Finding": { +"description": "Finding provides details for a single finding within an AISkillAnalysisOccurrence.", +"id": "Finding", +"properties": { +"category": { +"description": "Category of the finding.", +"type": "string" +}, +"description": { +"description": "Detailed description of the finding.", +"type": "string" +}, +"filePath": { +"description": "Path to the file where the finding was detected.", +"type": "string" +}, +"ruleId": { +"description": "Unique identifier of the rule that produced this finding.", +"type": "string" +}, +"severity": { +"description": "Severity of the finding.", +"type": "string" +}, +"snippet": { +"description": "Code snippet relevant to the finding.", +"type": "string" +}, +"title": { +"description": "Title of the finding.", +"type": "string" +} +}, +"type": "object" +}, "Fingerprint": { "description": "A set of properties that uniquely identify a given Docker image.", "id": "Fingerprint", @@ -1909,6 +1962,10 @@ "format": "google-datetime", "type": "string" }, +"aiSkillAnalysis": { +"$ref": "AISkillAnalysisOccurrence", +"description": "Describes an AI skill analysis." +}, "attestation": { "$ref": "AttestationOccurrence", "description": "Describes an attestation of an artifact." @@ -1962,7 +2019,8 @@ "DSSE_ATTESTATION", "VULNERABILITY_ASSESSMENT", "SBOM_REFERENCE", -"SECRET" +"SECRET", +"AI_SKILL_ANALYSIS" ], "enumDescriptions": [ "Default value. This value is unused.", @@ -1978,7 +2036,8 @@ "This represents a DSSE attestation Note", "This represents a Vulnerability Assessment.", "This represents an SBOM Reference.", -"This represents a secret." +"This represents a secret.", +"This represents an AI skill analysis." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/ondemandscanning.v1beta1.json b/googleapiclient/discovery_cache/documents/ondemandscanning.v1beta1.json index 48eda18d63..6cf4315bff 100644 --- a/googleapiclient/discovery_cache/documents/ondemandscanning.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/ondemandscanning.v1beta1.json @@ -344,9 +344,27 @@ } } }, -"revision": "20260323", +"revision": "20260330", "rootUrl": "https://ondemandscanning.googleapis.com/", "schemas": { +"AISkillAnalysisOccurrence": { +"description": "AISkillAnalysisOccurrence provides the results of an AI-based skill analysis.", +"id": "AISkillAnalysisOccurrence", +"properties": { +"findings": { +"description": "Findings produced by the analysis.", +"items": { +"$ref": "Finding" +}, +"type": "array" +}, +"skillName": { +"description": "Name of the skill that produced this analysis.", +"type": "string" +} +}, +"type": "object" +}, "AliasContext": { "description": "An alias to a repo revision.", "id": "AliasContext", @@ -1258,6 +1276,41 @@ }, "type": "object" }, +"Finding": { +"description": "Finding provides details for a single finding within an AISkillAnalysisOccurrence.", +"id": "Finding", +"properties": { +"category": { +"description": "Category of the finding.", +"type": "string" +}, +"description": { +"description": "Detailed description of the finding.", +"type": "string" +}, +"filePath": { +"description": "Path to the file where the finding was detected.", +"type": "string" +}, +"ruleId": { +"description": "Unique identifier of the rule that produced this finding.", +"type": "string" +}, +"severity": { +"description": "Severity of the finding.", +"type": "string" +}, +"snippet": { +"description": "Code snippet relevant to the finding.", +"type": "string" +}, +"title": { +"description": "Title of the finding.", +"type": "string" +} +}, +"type": "object" +}, "Fingerprint": { "description": "A set of properties that uniquely identify a given Docker image.", "id": "Fingerprint", @@ -1904,6 +1957,10 @@ "format": "google-datetime", "type": "string" }, +"aiSkillAnalysis": { +"$ref": "AISkillAnalysisOccurrence", +"description": "Describes an AI skill analysis." +}, "attestation": { "$ref": "AttestationOccurrence", "description": "Describes an attestation of an artifact." @@ -1957,7 +2014,8 @@ "DSSE_ATTESTATION", "VULNERABILITY_ASSESSMENT", "SBOM_REFERENCE", -"SECRET" +"SECRET", +"AI_SKILL_ANALYSIS" ], "enumDescriptions": [ "Default value. This value is unused.", @@ -1973,7 +2031,8 @@ "This represents a DSSE attestation Note", "This represents a Vulnerability Assessment.", "This represents an SBOM Reference.", -"This represents a secret." +"This represents a secret.", +"This represents an AI skill analysis." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/oracledatabase.v1.json b/googleapiclient/discovery_cache/documents/oracledatabase.v1.json index cd288936d1..c2a122b623 100644 --- a/googleapiclient/discovery_cache/documents/oracledatabase.v1.json +++ b/googleapiclient/discovery_cache/documents/oracledatabase.v1.json @@ -2504,7 +2504,7 @@ } } }, -"revision": "20260320", +"revision": "20260402", "rootUrl": "https://oracledatabase.googleapis.com/", "schemas": { "AllConnectionStrings": { @@ -2534,7 +2534,11 @@ "id": "AutonomousDatabase", "properties": { "adminPassword": { -"description": "Optional. Immutable. The password for the default ADMIN user.", +"description": "Optional. Immutable. The password for the default ADMIN user. Note: Only one of `admin_password_secret_version` or `admin_password` can be populated.", +"type": "string" +}, +"adminPasswordSecretVersion": { +"description": "Optional. Immutable. The resource name of a secret version in Secret Manager which contains the database admin user's password. Format: projects/{project}/secrets/{secret}/versions/{version}. Note: Only one of `admin_password_secret_version` or `admin_password` can be populated.", "type": "string" }, "cidr": { @@ -3119,7 +3123,8 @@ "type": "boolean" }, "isLocalDataGuardEnabled": { -"description": "Output only. This field indicates whether the Autonomous Database has local (in-region) Data Guard enabled.", +"deprecated": true, +"description": "Output only. Deprecated: Please use `local_data_guard_enabled` instead. This field indicates whether the Autonomous Database has local (in-region) Data Guard enabled.", "readOnly": true, "type": "boolean" }, @@ -3147,22 +3152,34 @@ "type": "string" }, "localAdgAutoFailoverMaxDataLossLimit": { -"description": "Output only. This field indicates the maximum data loss limit for an Autonomous Database, in seconds.", +"deprecated": true, +"description": "Output only. Deprecated: Please use `local_adg_auto_failover_max_data_loss_limit_duration` instead. This field indicates the maximum data loss limit for an Autonomous Database, in seconds.", "format": "int32", "readOnly": true, "type": "integer" }, +"localAdgAutoFailoverMaxDataLossLimitDuration": { +"description": "Optional. This field indicates the maximum data loss limit for an Autonomous Database, in seconds.", +"format": "int32", +"type": "integer" +}, +"localDataGuardEnabled": { +"description": "Optional. Indicates whether the Autonomous Database has a local (in-region) standby database. Not applicable to cross-region Data Guard or dedicated Exadata infrastructure.", +"type": "boolean" +}, "localDisasterRecoveryType": { "description": "Output only. This field indicates the local disaster recovery (DR) type of an Autonomous Database.", "enum": [ "LOCAL_DISASTER_RECOVERY_TYPE_UNSPECIFIED", "ADG", -"BACKUP_BASED" +"BACKUP_BASED", +"NOT_AVAILABLE" ], "enumDescriptions": [ "Default unspecified value.", "Autonomous Data Guard recovery.", -"Backup based recovery." +"Backup based recovery.", +"Local disaster recovery is not available." ], "readOnly": true, "type": "string" @@ -4246,7 +4263,11 @@ "id": "Database", "properties": { "adminPassword": { -"description": "Optional. The password for the default ADMIN user.", +"description": "Optional. The password for the default ADMIN user. Note: Only one of `admin_password_secret_version` or `admin_password` can be populated.", +"type": "string" +}, +"adminPasswordSecretVersion": { +"description": "Optional. The resource name of a secret version in Secret Manager which contains the database admin user's password. Format: projects/{project}/secrets/{secret}/versions/{version}. Note: Only one of `admin_password_secret_version` or `admin_password` can be populated.", "type": "string" }, "characterSet": { @@ -4329,7 +4350,11 @@ "description": "Optional. The properties of the Database." }, "tdeWalletPassword": { -"description": "Optional. The TDE wallet password for the database.", +"description": "Optional. The TDE wallet password for the database. Note: Only one of `tde_wallet_password_secret_version` or `tde_wallet_password` can be populated.", +"type": "string" +}, +"tdeWalletPasswordSecretVersion": { +"description": "Optional. The resource name of a secret version in Secret Manager which contains the TDE wallet password for the database. Format: projects/{project}/secrets/{secret}/versions/{version}. Note: Only one of `tde_wallet_password_secret_version` or `tde_wallet_password` can be populated.", "type": "string" } }, diff --git a/googleapiclient/discovery_cache/documents/parametermanager.v1.json b/googleapiclient/discovery_cache/documents/parametermanager.v1.json index d63d0c1349..fd4ab6c1e0 100644 --- a/googleapiclient/discovery_cache/documents/parametermanager.v1.json +++ b/googleapiclient/discovery_cache/documents/parametermanager.v1.json @@ -382,7 +382,7 @@ ] }, "list": { -"description": "Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.", +"description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "flatPath": "v1/projects/{projectsId}/locations", "httpMethod": "GET", "id": "parametermanager.projects.locations.list", @@ -841,7 +841,7 @@ } } }, -"revision": "20260309", +"revision": "20260325", "rootUrl": "https://parametermanager.googleapis.com/", "schemas": { "Empty": { diff --git a/googleapiclient/discovery_cache/documents/redis.v1.json b/googleapiclient/discovery_cache/documents/redis.v1.json index 8fac8756be..fb24ac80ac 100644 --- a/googleapiclient/discovery_cache/documents/redis.v1.json +++ b/googleapiclient/discovery_cache/documents/redis.v1.json @@ -4,6 +4,12 @@ "scopes": { "https://www.googleapis.com/auth/cloud-platform": { "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." +}, +"https://www.googleapis.com/auth/redis.read-only": { +"description": "See your Google Cloud Memorystore for Redis data and the email address of your Google Account" +}, +"https://www.googleapis.com/auth/redis.read-write": { +"description": "See, edit, configure, and delete your Google Cloud Memorystore for Redis data and see the email address for your Google Account" } } } @@ -131,7 +137,8 @@ "$ref": "Location" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/redis.read-write" ] }, "getSharedRegionalCertificateAuthority": { @@ -156,7 +163,8 @@ "$ref": "SharedRegionalCertificateAuthority" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/redis.read-write" ] }, "list": { @@ -203,7 +211,8 @@ "$ref": "ListLocationsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/redis.read-write" ] } }, @@ -245,7 +254,8 @@ "$ref": "AclPolicy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/redis.read-write" ] }, "delete": { @@ -280,7 +290,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/redis.read-write" ] }, "get": { @@ -305,7 +316,8 @@ "$ref": "AclPolicy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/redis.read-write" ] }, "list": { @@ -341,7 +353,8 @@ "$ref": "ListAclPoliciesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/redis.read-write" ] }, "patch": { @@ -380,7 +393,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/redis.read-write" ] } } @@ -409,7 +423,9 @@ "$ref": "BackupCollection" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/redis.read-only", +"https://www.googleapis.com/auth/redis.read-write" ] }, "list": { @@ -445,7 +461,9 @@ "$ref": "ListBackupCollectionsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/redis.read-only", +"https://www.googleapis.com/auth/redis.read-write" ] } }, @@ -479,7 +497,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/redis.read-write" ] }, "export": { @@ -507,7 +526,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/redis.read-write" ] }, "get": { @@ -532,7 +552,9 @@ "$ref": "Backup" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/redis.read-only", +"https://www.googleapis.com/auth/redis.read-write" ] }, "list": { @@ -568,7 +590,9 @@ "$ref": "ListBackupsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/redis.read-only", +"https://www.googleapis.com/auth/redis.read-write" ] } } @@ -577,6 +601,35 @@ }, "clusters": { "methods": { +"addTokenAuthUser": { +"description": "Adds a token auth user for a token based auth enabled cluster.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:addTokenAuthUser", +"httpMethod": "POST", +"id": "redis.projects.locations.clusters.addTokenAuthUser", +"parameterOrder": [ +"cluster" +], +"parameters": { +"cluster": { +"description": "Required. The cluster resource that this token auth user will be added for. Format: projects/{project}/locations/{location}/clusters/{cluster}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+cluster}:addTokenAuthUser", +"request": { +"$ref": "AddTokenAuthUserRequest" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/redis.read-write" +] +}, "backup": { "description": "Backup Redis Cluster. If this is the first time a backup is being created, a backup collection will be created at the backend, and this backup belongs to this collection. Both collection and backup will have a resource name. Backup will be executed for each shard. A replica (primary if nonHA) will be selected to perform the execution. Backup call will be rejected if there is an ongoing backup or update operation. Be aware that during preview, if the cluster's internal software version is too old, critical update will be performed before actual backup. Once the internal software version is updated to the minimum version required by the backup feature, subsequent backups will not require critical update. After preview, there will be no critical update needed for backup.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:backup", @@ -602,7 +655,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/redis.read-write" ] }, "create": { @@ -640,7 +694,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/redis.read-write" ] }, "delete": { @@ -670,7 +725,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/redis.read-write" ] }, "get": { @@ -695,7 +751,8 @@ "$ref": "Cluster" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/redis.read-write" ] }, "getCertificateAuthority": { @@ -720,7 +777,8 @@ "$ref": "CertificateAuthority" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/redis.read-write" ] }, "list": { @@ -756,7 +814,8 @@ "$ref": "ListClustersResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/redis.read-write" ] }, "patch": { @@ -795,7 +854,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/redis.read-write" ] }, "rescheduleClusterMaintenance": { @@ -823,10 +883,260 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/redis.read-write" +] +} +}, +"resources": { +"tokenAuthUsers": { +"methods": { +"addAuthToken": { +"description": "Adds a auth token for a user of a token based auth enabled cluster.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/tokenAuthUsers/{tokenAuthUsersId}:addAuthToken", +"httpMethod": "POST", +"id": "redis.projects.locations.clusters.tokenAuthUsers.addAuthToken", +"parameterOrder": [ +"tokenAuthUser" +], +"parameters": { +"tokenAuthUser": { +"description": "Required. The name of the token auth user resource that this auth token will be added for. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/tokenAuthUsers/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+tokenAuthUser}:addAuthToken", +"request": { +"$ref": "AddAuthTokenRequest" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/redis.read-write" +] +}, +"delete": { +"description": "Deletes a token auth user for a token based auth enabled cluster.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/tokenAuthUsers/{tokenAuthUsersId}", +"httpMethod": "DELETE", +"id": "redis.projects.locations.clusters.tokenAuthUsers.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"force": { +"description": "Optional. If set to true, any child auth tokens of this user will also be deleted. Otherwise, the request will only work if the user has no auth tokens.", +"location": "query", +"type": "boolean" +}, +"name": { +"description": "Required. The name of the token auth user to delete. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/tokenAuthUsers/[^/]+$", +"required": true, +"type": "string" +}, +"requestId": { +"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/redis.read-write" +] +}, +"get": { +"description": "Gets a specific token auth user for a basic auth enabled cluster.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/tokenAuthUsers/{tokenAuthUsersId}", +"httpMethod": "GET", +"id": "redis.projects.locations.clusters.tokenAuthUsers.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of token auth user for a token based auth enabled cluster. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/tokenAuthUsers/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "TokenAuthUser" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/redis.read-write" +] +}, +"list": { +"description": "Lists all the token auth users for a token based auth enabled cluster.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/tokenAuthUsers", +"httpMethod": "GET", +"id": "redis.projects.locations.clusters.tokenAuthUsers.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. Expression for filtering results.", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Optional. Sort results by a defined order.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. The maximum number of items to return. If not specified, a default value of 1000 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's The maximum value is 1000; values above 1000 will be coerced to 1000. `next_page_token` to determine if there are more clusters left to be queried.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. The `next_page_token` value returned from a previous [ListTokenAuthUsers] request, if any.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent resource that this token based auth user will be listed for. Format: projects/{project}/locations/{location}/clusters/{cluster}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/tokenAuthUsers", +"response": { +"$ref": "ListTokenAuthUsersResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/redis.read-write" +] +} +}, +"resources": { +"authTokens": { +"methods": { +"delete": { +"description": "Removes a auth token for a user of a token based auth enabled instance.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/tokenAuthUsers/{tokenAuthUsersId}/authTokens/{authTokensId}", +"httpMethod": "DELETE", +"id": "redis.projects.locations.clusters.tokenAuthUsers.authTokens.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the token auth user resource that this auth token will be deleted from. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user}/authTokens/{auth_token}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/tokenAuthUsers/[^/]+/authTokens/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/redis.read-write" +] +}, +"get": { +"description": "Gets a specific auth token for a specific token auth user.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/tokenAuthUsers/{tokenAuthUsersId}/authTokens/{authTokensId}", +"httpMethod": "GET", +"id": "redis.projects.locations.clusters.tokenAuthUsers.authTokens.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of auth token for a token based auth enabled cluster. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user}/authTokens/{auth_token}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/tokenAuthUsers/[^/]+/authTokens/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "AuthToken" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/redis.read-write" +] +}, +"list": { +"description": "Lists all the auth tokens for a specific token auth user.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/tokenAuthUsers/{tokenAuthUsersId}/authTokens", +"httpMethod": "GET", +"id": "redis.projects.locations.clusters.tokenAuthUsers.authTokens.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. Expression for filtering results.", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Optional. Sort results by a defined order.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. The maximum number of items to return. The maximum value is 1000; values above 1000 will be coerced to 1000. If not specified, a default value of 1000 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's `next_page_token` to determine if there are more clusters left to be queried.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. The `next_page_token` value returned from a previous [ListTokenAuthUsers] request, if any.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent resource that this auth token will be listed for. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/tokenAuthUsers/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/authTokens", +"response": { +"$ref": "ListAuthTokensResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/redis.read-write" ] } } +} +} +} +} }, "instances": { "methods": { @@ -860,7 +1170,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/redis.read-write" ] }, "delete": { @@ -885,7 +1196,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/redis.read-write" ] }, "export": { @@ -913,7 +1225,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/redis.read-write" ] }, "failover": { @@ -941,7 +1254,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/redis.read-write" ] }, "get": { @@ -966,7 +1280,9 @@ "$ref": "Instance" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/redis.read-only", +"https://www.googleapis.com/auth/redis.read-write" ] }, "getAuthString": { @@ -991,7 +1307,9 @@ "$ref": "InstanceAuthString" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/redis.read-only", +"https://www.googleapis.com/auth/redis.read-write" ] }, "import": { @@ -1019,7 +1337,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/redis.read-write" ] }, "list": { @@ -1055,7 +1374,9 @@ "$ref": "ListInstancesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/redis.read-only", +"https://www.googleapis.com/auth/redis.read-write" ] }, "patch": { @@ -1089,7 +1410,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/redis.read-write" ] }, "rescheduleMaintenance": { @@ -1117,7 +1439,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/redis.read-write" ] }, "upgrade": { @@ -1145,7 +1468,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/redis.read-write" ] } } @@ -1174,7 +1498,8 @@ "$ref": "Empty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/redis.read-write" ] }, "delete": { @@ -1199,7 +1524,8 @@ "$ref": "Empty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/redis.read-write" ] }, "get": { @@ -1224,7 +1550,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/redis.read-write" ] }, "list": { @@ -1270,7 +1597,8 @@ "$ref": "ListOperationsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/redis.read-write" ] } } @@ -1280,7 +1608,7 @@ } } }, -"revision": "20260324", +"revision": "20260331", "rootUrl": "https://redis.googleapis.com/", "schemas": { "AOFConfig": { @@ -1367,6 +1695,67 @@ }, "type": "object" }, +"AddAuthTokenRequest": { +"description": "Request message for AddAuthToken.", +"id": "AddAuthTokenRequest", +"properties": { +"authToken": { +"$ref": "AuthToken", +"description": "Required. The auth token to add." +} +}, +"type": "object" +}, +"AddTokenAuthUserRequest": { +"description": "Request message for AddTokenAuthUser.", +"id": "AddTokenAuthUserRequest", +"properties": { +"tokenAuthUser": { +"description": "Required. The id of the token auth user to add.", +"type": "string" +} +}, +"type": "object" +}, +"AuthToken": { +"description": "Auth token for the cluster.", +"id": "AuthToken", +"properties": { +"createTime": { +"description": "Output only. Create time of the auth token.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Identifier. Name of the auth token. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user}/authTokens/{auth_token}", +"type": "string" +}, +"state": { +"description": "Output only. State of the auth token.", +"enum": [ +"STATE_UNSPECIFIED", +"ACTIVE", +"CREATING", +"DELETING" +], +"enumDescriptions": [ +"Not set.", +"The auth token is active.", +"The auth token is being created.", +"The auth token is being deleted." +], +"readOnly": true, +"type": "string" +}, +"token": { +"description": "Output only. The service generated authentication token used to connect to the Redis cluster.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "AutomatedBackupConfig": { "description": "The automated backup config for a cluster.", "id": "AutomatedBackupConfig", @@ -1809,12 +2198,14 @@ "enum": [ "AUTH_MODE_UNSPECIFIED", "AUTH_MODE_IAM_AUTH", -"AUTH_MODE_DISABLED" +"AUTH_MODE_DISABLED", +"AUTH_MODE_TOKEN_AUTH" ], "enumDescriptions": [ "Not set.", "IAM basic authorization mode", -"Authorization disabled mode" +"Authorization disabled mode", +"Token based authorization mode" ], "type": "string" }, @@ -4323,6 +4714,31 @@ false }, "type": "object" }, +"ListAuthTokensResponse": { +"description": "Response message for ListAuthTokens.", +"id": "ListAuthTokensResponse", +"properties": { +"authTokens": { +"description": "A list of auth tokens in the project.", +"items": { +"$ref": "AuthToken" +}, +"type": "array" +}, +"nextPageToken": { +"description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", +"type": "string" +}, +"unreachable": { +"description": "Unordered list. Auth tokens that could not be reached.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "ListBackupCollectionsResponse": { "description": "Response for [ListBackupCollections].", "id": "ListBackupCollectionsResponse", @@ -4466,6 +4882,31 @@ false }, "type": "object" }, +"ListTokenAuthUsersResponse": { +"description": "Response message for ListTokenAuthUsers.", +"id": "ListTokenAuthUsersResponse", +"properties": { +"nextPageToken": { +"description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", +"type": "string" +}, +"tokenAuthUsers": { +"description": "A list of token auth users in the project.", +"items": { +"$ref": "TokenAuthUser" +}, +"type": "array" +}, +"unreachable": { +"description": "Unordered list. Token auth users that could not be reached.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "Location": { "description": "A resource that represents a Google Cloud location.", "id": "Location", @@ -5698,6 +6139,36 @@ false }, "type": "object" }, +"TokenAuthUser": { +"description": "Represents a token based auth user for the cluster.", +"id": "TokenAuthUser", +"properties": { +"name": { +"description": "Identifier. The resource name of the token based auth user. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user}", +"type": "string" +}, +"state": { +"description": "Output only. The state of the token based auth user.", +"enum": [ +"STATE_UNSPECIFIED", +"ACTIVE", +"CREATING", +"UPDATING", +"DELETING" +], +"enumDescriptions": [ +"Not set.", +"The auth user is active.", +"The auth user is being created.", +"The auth user is being updated.", +"The auth user is being deleted." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "TypedValue": { "description": "TypedValue represents the value of a metric type. It can either be a double, an int64, a string or a bool.", "id": "TypedValue", diff --git a/googleapiclient/discovery_cache/documents/redis.v1beta1.json b/googleapiclient/discovery_cache/documents/redis.v1beta1.json index c535f170c1..1e8610826f 100644 --- a/googleapiclient/discovery_cache/documents/redis.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/redis.v1beta1.json @@ -4,6 +4,12 @@ "scopes": { "https://www.googleapis.com/auth/cloud-platform": { "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." +}, +"https://www.googleapis.com/auth/redis.read-only": { +"description": "See your Google Cloud Memorystore for Redis data and the email address of your Google Account" +}, +"https://www.googleapis.com/auth/redis.read-write": { +"description": "See, edit, configure, and delete your Google Cloud Memorystore for Redis data and see the email address for your Google Account" } } } @@ -131,7 +137,8 @@ "$ref": "Location" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/redis.read-write" ] }, "getSharedRegionalCertificateAuthority": { @@ -156,7 +163,8 @@ "$ref": "SharedRegionalCertificateAuthority" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/redis.read-write" ] }, "list": { @@ -203,7 +211,8 @@ "$ref": "ListLocationsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/redis.read-write" ] } }, @@ -245,7 +254,8 @@ "$ref": "AclPolicy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/redis.read-write" ] }, "delete": { @@ -280,7 +290,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/redis.read-write" ] }, "get": { @@ -305,7 +316,8 @@ "$ref": "AclPolicy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/redis.read-write" ] }, "list": { @@ -341,7 +353,8 @@ "$ref": "ListAclPoliciesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/redis.read-write" ] }, "patch": { @@ -380,7 +393,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/redis.read-write" ] } } @@ -409,7 +423,8 @@ "$ref": "BackupCollection" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/redis.read-write" ] }, "list": { @@ -445,7 +460,8 @@ "$ref": "ListBackupCollectionsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/redis.read-write" ] } }, @@ -479,7 +495,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/redis.read-write" ] }, "export": { @@ -507,7 +524,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/redis.read-write" ] }, "get": { @@ -532,7 +550,8 @@ "$ref": "Backup" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/redis.read-write" ] }, "list": { @@ -568,7 +587,8 @@ "$ref": "ListBackupsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/redis.read-write" ] } } @@ -577,6 +597,35 @@ }, "clusters": { "methods": { +"addTokenAuthUser": { +"description": "Adds a token auth user for a token based auth enabled cluster.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:addTokenAuthUser", +"httpMethod": "POST", +"id": "redis.projects.locations.clusters.addTokenAuthUser", +"parameterOrder": [ +"cluster" +], +"parameters": { +"cluster": { +"description": "Required. The cluster resource that this token auth user will be added for. Format: projects/{project}/locations/{location}/clusters/{cluster}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+cluster}:addTokenAuthUser", +"request": { +"$ref": "AddTokenAuthUserRequest" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/redis.read-write" +] +}, "backup": { "description": "Backup Redis Cluster. If this is the first time a backup is being created, a backup collection will be created at the backend, and this backup belongs to this collection. Both collection and backup will have a resource name. Backup will be executed for each shard. A replica (primary if nonHA) will be selected to perform the execution. Backup call will be rejected if there is an ongoing backup or update operation. Be aware that during preview, if the cluster's internal software version is too old, critical update will be performed before actual backup. Once the internal software version is updated to the minimum version required by the backup feature, subsequent backups will not require critical update. After preview, there will be no critical update needed for backup.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:backup", @@ -602,7 +651,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/redis.read-write" ] }, "create": { @@ -640,7 +690,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/redis.read-write" ] }, "delete": { @@ -670,7 +721,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/redis.read-write" ] }, "get": { @@ -695,7 +747,8 @@ "$ref": "Cluster" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/redis.read-write" ] }, "getCertificateAuthority": { @@ -720,7 +773,8 @@ "$ref": "CertificateAuthority" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/redis.read-write" ] }, "list": { @@ -756,7 +810,8 @@ "$ref": "ListClustersResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/redis.read-write" ] }, "patch": { @@ -795,7 +850,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/redis.read-write" ] }, "rescheduleClusterMaintenance": { @@ -823,10 +879,260 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/redis.read-write" +] +} +}, +"resources": { +"tokenAuthUsers": { +"methods": { +"addAuthToken": { +"description": "Adds a auth token for a user of a token based auth enabled cluster.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/tokenAuthUsers/{tokenAuthUsersId}:addAuthToken", +"httpMethod": "POST", +"id": "redis.projects.locations.clusters.tokenAuthUsers.addAuthToken", +"parameterOrder": [ +"tokenAuthUser" +], +"parameters": { +"tokenAuthUser": { +"description": "Required. The name of the token auth user resource that this auth token will be added for. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/tokenAuthUsers/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+tokenAuthUser}:addAuthToken", +"request": { +"$ref": "AddAuthTokenRequest" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/redis.read-write" +] +}, +"delete": { +"description": "Deletes a token auth user for a token based auth enabled cluster.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/tokenAuthUsers/{tokenAuthUsersId}", +"httpMethod": "DELETE", +"id": "redis.projects.locations.clusters.tokenAuthUsers.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"force": { +"description": "Optional. If set to true, any child auth tokens of this user will also be deleted. Otherwise, the request will only work if the user has no auth tokens.", +"location": "query", +"type": "boolean" +}, +"name": { +"description": "Required. The name of the token auth user to delete. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/tokenAuthUsers/[^/]+$", +"required": true, +"type": "string" +}, +"requestId": { +"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/redis.read-write" +] +}, +"get": { +"description": "Gets a specific token auth user for a basic auth enabled cluster.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/tokenAuthUsers/{tokenAuthUsersId}", +"httpMethod": "GET", +"id": "redis.projects.locations.clusters.tokenAuthUsers.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of token auth user for a token based auth enabled cluster. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/tokenAuthUsers/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "TokenAuthUser" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/redis.read-write" +] +}, +"list": { +"description": "Lists all the token auth users for a token based auth enabled cluster.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/tokenAuthUsers", +"httpMethod": "GET", +"id": "redis.projects.locations.clusters.tokenAuthUsers.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. Expression for filtering results.", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Optional. Sort results by a defined order.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. The maximum number of items to return. If not specified, a default value of 1000 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's The maximum value is 1000; values above 1000 will be coerced to 1000. `next_page_token` to determine if there are more clusters left to be queried.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. The `next_page_token` value returned from a previous [ListTokenAuthUsers] request, if any.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent resource that this token based auth user will be listed for. Format: projects/{project}/locations/{location}/clusters/{cluster}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+parent}/tokenAuthUsers", +"response": { +"$ref": "ListTokenAuthUsersResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/redis.read-write" +] +} +}, +"resources": { +"authTokens": { +"methods": { +"delete": { +"description": "Removes a auth token for a user of a token based auth enabled instance.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/tokenAuthUsers/{tokenAuthUsersId}/authTokens/{authTokensId}", +"httpMethod": "DELETE", +"id": "redis.projects.locations.clusters.tokenAuthUsers.authTokens.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the token auth user resource that this auth token will be deleted from. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user}/authTokens/{auth_token}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/tokenAuthUsers/[^/]+/authTokens/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/redis.read-write" +] +}, +"get": { +"description": "Gets a specific auth token for a specific token auth user.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/tokenAuthUsers/{tokenAuthUsersId}/authTokens/{authTokensId}", +"httpMethod": "GET", +"id": "redis.projects.locations.clusters.tokenAuthUsers.authTokens.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of auth token for a token based auth enabled cluster. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user}/authTokens/{auth_token}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/tokenAuthUsers/[^/]+/authTokens/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "AuthToken" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/redis.read-write" +] +}, +"list": { +"description": "Lists all the auth tokens for a specific token auth user.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/tokenAuthUsers/{tokenAuthUsersId}/authTokens", +"httpMethod": "GET", +"id": "redis.projects.locations.clusters.tokenAuthUsers.authTokens.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. Expression for filtering results.", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Optional. Sort results by a defined order.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. The maximum number of items to return. The maximum value is 1000; values above 1000 will be coerced to 1000. If not specified, a default value of 1000 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's `next_page_token` to determine if there are more clusters left to be queried.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. The `next_page_token` value returned from a previous [ListTokenAuthUsers] request, if any.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent resource that this auth token will be listed for. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/tokenAuthUsers/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+parent}/authTokens", +"response": { +"$ref": "ListAuthTokensResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/redis.read-write" ] } } +} +} +} +} }, "instances": { "methods": { @@ -860,7 +1166,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/redis.read-write" ] }, "delete": { @@ -885,7 +1192,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/redis.read-write" ] }, "export": { @@ -913,7 +1221,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/redis.read-write" ] }, "failover": { @@ -941,7 +1250,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/redis.read-write" ] }, "get": { @@ -966,7 +1276,9 @@ "$ref": "Instance" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/redis.read-only", +"https://www.googleapis.com/auth/redis.read-write" ] }, "getAuthString": { @@ -991,7 +1303,9 @@ "$ref": "InstanceAuthString" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/redis.read-only", +"https://www.googleapis.com/auth/redis.read-write" ] }, "import": { @@ -1019,7 +1333,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/redis.read-write" ] }, "list": { @@ -1055,7 +1370,9 @@ "$ref": "ListInstancesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/redis.read-only", +"https://www.googleapis.com/auth/redis.read-write" ] }, "patch": { @@ -1089,7 +1406,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/redis.read-write" ] }, "rescheduleMaintenance": { @@ -1117,7 +1435,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/redis.read-write" ] }, "upgrade": { @@ -1145,7 +1464,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/redis.read-write" ] } } @@ -1174,7 +1494,8 @@ "$ref": "Empty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/redis.read-write" ] }, "delete": { @@ -1199,7 +1520,8 @@ "$ref": "Empty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/redis.read-write" ] }, "get": { @@ -1224,7 +1546,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/redis.read-write" ] }, "list": { @@ -1270,7 +1593,8 @@ "$ref": "ListOperationsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/redis.read-write" ] } } @@ -1280,7 +1604,7 @@ } } }, -"revision": "20260324", +"revision": "20260331", "rootUrl": "https://redis.googleapis.com/", "schemas": { "AOFConfig": { @@ -1367,6 +1691,67 @@ }, "type": "object" }, +"AddAuthTokenRequest": { +"description": "Request message for AddAuthToken.", +"id": "AddAuthTokenRequest", +"properties": { +"authToken": { +"$ref": "AuthToken", +"description": "Required. The auth token to add." +} +}, +"type": "object" +}, +"AddTokenAuthUserRequest": { +"description": "Request message for AddTokenAuthUser.", +"id": "AddTokenAuthUserRequest", +"properties": { +"tokenAuthUser": { +"description": "Required. The id of the token auth user to add.", +"type": "string" +} +}, +"type": "object" +}, +"AuthToken": { +"description": "Auth token for the cluster.", +"id": "AuthToken", +"properties": { +"createTime": { +"description": "Output only. Create time of the auth token.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Identifier. Name of the auth token. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user}/authTokens/{auth_token}", +"type": "string" +}, +"state": { +"description": "Output only. State of the auth token.", +"enum": [ +"STATE_UNSPECIFIED", +"ACTIVE", +"CREATING", +"DELETING" +], +"enumDescriptions": [ +"Not set.", +"The auth token is active.", +"The auth token is being created.", +"The auth token is being deleted." +], +"readOnly": true, +"type": "string" +}, +"token": { +"description": "Output only. The service generated authentication token used to connect to the Redis cluster.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "AutomatedBackupConfig": { "description": "The automated backup config for a cluster.", "id": "AutomatedBackupConfig", @@ -1809,12 +2194,14 @@ "enum": [ "AUTH_MODE_UNSPECIFIED", "AUTH_MODE_IAM_AUTH", -"AUTH_MODE_DISABLED" +"AUTH_MODE_DISABLED", +"AUTH_MODE_TOKEN_AUTH" ], "enumDescriptions": [ "Not set.", "IAM basic authorization mode", -"Authorization disabled mode" +"Authorization disabled mode", +"Token based authorization mode" ], "type": "string" }, @@ -4330,6 +4717,31 @@ false }, "type": "object" }, +"ListAuthTokensResponse": { +"description": "Response message for ListAuthTokens.", +"id": "ListAuthTokensResponse", +"properties": { +"authTokens": { +"description": "A list of auth tokens in the project.", +"items": { +"$ref": "AuthToken" +}, +"type": "array" +}, +"nextPageToken": { +"description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", +"type": "string" +}, +"unreachable": { +"description": "Unordered list. Auth tokens that could not be reached.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "ListBackupCollectionsResponse": { "description": "Response for [ListBackupCollections].", "id": "ListBackupCollectionsResponse", @@ -4473,6 +4885,31 @@ false }, "type": "object" }, +"ListTokenAuthUsersResponse": { +"description": "Response message for ListTokenAuthUsers.", +"id": "ListTokenAuthUsersResponse", +"properties": { +"nextPageToken": { +"description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", +"type": "string" +}, +"tokenAuthUsers": { +"description": "A list of token auth users in the project.", +"items": { +"$ref": "TokenAuthUser" +}, +"type": "array" +}, +"unreachable": { +"description": "Unordered list. Token auth users that could not be reached.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "Location": { "description": "A resource that represents a Google Cloud location.", "id": "Location", @@ -5705,6 +6142,36 @@ false }, "type": "object" }, +"TokenAuthUser": { +"description": "Represents a token based auth user for the cluster.", +"id": "TokenAuthUser", +"properties": { +"name": { +"description": "Identifier. The resource name of the token based auth user. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user}", +"type": "string" +}, +"state": { +"description": "Output only. The state of the token based auth user.", +"enum": [ +"STATE_UNSPECIFIED", +"ACTIVE", +"CREATING", +"UPDATING", +"DELETING" +], +"enumDescriptions": [ +"Not set.", +"The auth user is active.", +"The auth user is being created.", +"The auth user is being updated.", +"The auth user is being deleted." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "TypedValue": { "description": "TypedValue represents the value of a metric type. It can either be a double, an int64, a string or a bool.", "id": "TypedValue", diff --git a/googleapiclient/discovery_cache/documents/run.v1.json b/googleapiclient/discovery_cache/documents/run.v1.json index 66272fa476..2c40757036 100644 --- a/googleapiclient/discovery_cache/documents/run.v1.json +++ b/googleapiclient/discovery_cache/documents/run.v1.json @@ -3583,7 +3583,7 @@ } } }, -"revision": "20260320", +"revision": "20260327", "rootUrl": "https://run.googleapis.com/", "schemas": { "Addressable": { @@ -4483,6 +4483,13 @@ "description": "Artifacts produced by a build that should be uploaded upon successful completion of all build steps.", "id": "GoogleDevtoolsCloudbuildV1Artifacts", "properties": { +"genericArtifacts": { +"description": "Optional. A list of generic artifacts to be uploaded to Artifact Registry upon successful completion of all build steps. If any artifacts fail to be pushed, the build is marked FAILURE.", +"items": { +"$ref": "GoogleDevtoolsCloudbuildV1GenericArtifact" +}, +"type": "array" +}, "goModules": { "description": "Optional. A list of Go modules to be uploaded to Artifact Registry upon successful completion of all build steps. If any objects fail to be pushed, the build is marked FAILURE.", "items": { @@ -5163,6 +5170,10 @@ false "description": "If set to true disable all dependency fetching (ignoring the default source as well).", "type": "boolean" }, +"genericArtifact": { +"$ref": "GoogleDevtoolsCloudbuildV1GenericArtifactDependency", +"description": "Represents a generic artifact as a build dependency." +}, "gitSource": { "$ref": "GoogleDevtoolsCloudbuildV1GitSourceDependency", "description": "Represents a git repository as a build dependency." @@ -5236,6 +5247,36 @@ false }, "type": "object" }, +"GoogleDevtoolsCloudbuildV1GenericArtifact": { +"description": "Generic artifact to upload to Artifact Registry upon successful completion of all build steps.", +"id": "GoogleDevtoolsCloudbuildV1GenericArtifact", +"properties": { +"folder": { +"description": "Required. Path to the generic artifact in the build's workspace to be uploaded to Artifact Registry.", +"type": "string" +}, +"registryPath": { +"description": "Required. Registry path to upload the generic artifact to, in the form projects/$PROJECT/locations/$LOCATION/repositories/$REPO/packages/$PACKAGE/versions/$VERSION", +"type": "string" +} +}, +"type": "object" +}, +"GoogleDevtoolsCloudbuildV1GenericArtifactDependency": { +"description": "Represents a generic artifact as a build dependency.", +"id": "GoogleDevtoolsCloudbuildV1GenericArtifactDependency", +"properties": { +"destPath": { +"description": "Required. Where the artifact files should be placed on the worker.", +"type": "string" +}, +"resource": { +"description": "Required. The location to download the artifact files from. Ex: projects/p1/locations/us/repositories/r1/packages/p1/versions/v1", +"type": "string" +} +}, +"type": "object" +}, "GoogleDevtoolsCloudbuildV1GitConfig": { "description": "GitConfig is a configuration for git operations.", "id": "GoogleDevtoolsCloudbuildV1GitConfig", @@ -5568,6 +5609,14 @@ false }, "type": "array" }, +"genericArtifacts": { +"description": "Output only. Generic artifacts uploaded to Artifact Registry at the end of the build.", +"items": { +"$ref": "GoogleDevtoolsCloudbuildV1UploadedGenericArtifact" +}, +"readOnly": true, +"type": "array" +}, "goModules": { "description": "Optional. Go module artifacts uploaded to Artifact Registry at the end of the build.", "items": { @@ -5805,6 +5854,41 @@ false }, "type": "object" }, +"GoogleDevtoolsCloudbuildV1UploadedGenericArtifact": { +"description": "A generic artifact uploaded to Artifact Registry using the GenericArtifact directive.", +"id": "GoogleDevtoolsCloudbuildV1UploadedGenericArtifact", +"properties": { +"artifactFingerprint": { +"$ref": "GoogleDevtoolsCloudbuildV1FileHashes", +"description": "Output only. The hash of the whole artifact.", +"readOnly": true +}, +"artifactRegistryPackage": { +"description": "Output only. Path to the artifact in Artifact Registry.", +"readOnly": true, +"type": "string" +}, +"fileHashes": { +"additionalProperties": { +"$ref": "GoogleDevtoolsCloudbuildV1FileHashes" +}, +"description": "Output only. The file hashes that make up the generic artifact.", +"readOnly": true, +"type": "object" +}, +"pushTiming": { +"$ref": "GoogleDevtoolsCloudbuildV1TimeSpan", +"description": "Output only. Stores timing information for pushing the specified artifact.", +"readOnly": true +}, +"uri": { +"description": "Output only. URI of the uploaded artifact. Ex: projects/p1/locations/us/repositories/r1/packages/p1/versions/v1", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GoogleDevtoolsCloudbuildV1UploadedGoModule": { "description": "A Go module artifact uploaded to Artifact Registry using the GoModule directive.", "id": "GoogleDevtoolsCloudbuildV1UploadedGoModule", diff --git a/googleapiclient/discovery_cache/documents/run.v2.json b/googleapiclient/discovery_cache/documents/run.v2.json index 6b57845bbc..db1805840a 100644 --- a/googleapiclient/discovery_cache/documents/run.v2.json +++ b/googleapiclient/discovery_cache/documents/run.v2.json @@ -2473,7 +2473,7 @@ } } }, -"revision": "20260320", +"revision": "20260327", "rootUrl": "https://run.googleapis.com/", "schemas": { "GoogleCloudRunV2BinaryAuthorization": { @@ -6007,6 +6007,13 @@ "description": "Artifacts produced by a build that should be uploaded upon successful completion of all build steps.", "id": "GoogleDevtoolsCloudbuildV1Artifacts", "properties": { +"genericArtifacts": { +"description": "Optional. A list of generic artifacts to be uploaded to Artifact Registry upon successful completion of all build steps. If any artifacts fail to be pushed, the build is marked FAILURE.", +"items": { +"$ref": "GoogleDevtoolsCloudbuildV1GenericArtifact" +}, +"type": "array" +}, "goModules": { "description": "Optional. A list of Go modules to be uploaded to Artifact Registry upon successful completion of all build steps. If any objects fail to be pushed, the build is marked FAILURE.", "items": { @@ -6687,6 +6694,10 @@ false "description": "If set to true disable all dependency fetching (ignoring the default source as well).", "type": "boolean" }, +"genericArtifact": { +"$ref": "GoogleDevtoolsCloudbuildV1GenericArtifactDependency", +"description": "Represents a generic artifact as a build dependency." +}, "gitSource": { "$ref": "GoogleDevtoolsCloudbuildV1GitSourceDependency", "description": "Represents a git repository as a build dependency." @@ -6760,6 +6771,36 @@ false }, "type": "object" }, +"GoogleDevtoolsCloudbuildV1GenericArtifact": { +"description": "Generic artifact to upload to Artifact Registry upon successful completion of all build steps.", +"id": "GoogleDevtoolsCloudbuildV1GenericArtifact", +"properties": { +"folder": { +"description": "Required. Path to the generic artifact in the build's workspace to be uploaded to Artifact Registry.", +"type": "string" +}, +"registryPath": { +"description": "Required. Registry path to upload the generic artifact to, in the form projects/$PROJECT/locations/$LOCATION/repositories/$REPO/packages/$PACKAGE/versions/$VERSION", +"type": "string" +} +}, +"type": "object" +}, +"GoogleDevtoolsCloudbuildV1GenericArtifactDependency": { +"description": "Represents a generic artifact as a build dependency.", +"id": "GoogleDevtoolsCloudbuildV1GenericArtifactDependency", +"properties": { +"destPath": { +"description": "Required. Where the artifact files should be placed on the worker.", +"type": "string" +}, +"resource": { +"description": "Required. The location to download the artifact files from. Ex: projects/p1/locations/us/repositories/r1/packages/p1/versions/v1", +"type": "string" +} +}, +"type": "object" +}, "GoogleDevtoolsCloudbuildV1GitConfig": { "description": "GitConfig is a configuration for git operations.", "id": "GoogleDevtoolsCloudbuildV1GitConfig", @@ -7092,6 +7133,14 @@ false }, "type": "array" }, +"genericArtifacts": { +"description": "Output only. Generic artifacts uploaded to Artifact Registry at the end of the build.", +"items": { +"$ref": "GoogleDevtoolsCloudbuildV1UploadedGenericArtifact" +}, +"readOnly": true, +"type": "array" +}, "goModules": { "description": "Optional. Go module artifacts uploaded to Artifact Registry at the end of the build.", "items": { @@ -7329,6 +7378,41 @@ false }, "type": "object" }, +"GoogleDevtoolsCloudbuildV1UploadedGenericArtifact": { +"description": "A generic artifact uploaded to Artifact Registry using the GenericArtifact directive.", +"id": "GoogleDevtoolsCloudbuildV1UploadedGenericArtifact", +"properties": { +"artifactFingerprint": { +"$ref": "GoogleDevtoolsCloudbuildV1FileHashes", +"description": "Output only. The hash of the whole artifact.", +"readOnly": true +}, +"artifactRegistryPackage": { +"description": "Output only. Path to the artifact in Artifact Registry.", +"readOnly": true, +"type": "string" +}, +"fileHashes": { +"additionalProperties": { +"$ref": "GoogleDevtoolsCloudbuildV1FileHashes" +}, +"description": "Output only. The file hashes that make up the generic artifact.", +"readOnly": true, +"type": "object" +}, +"pushTiming": { +"$ref": "GoogleDevtoolsCloudbuildV1TimeSpan", +"description": "Output only. Stores timing information for pushing the specified artifact.", +"readOnly": true +}, +"uri": { +"description": "Output only. URI of the uploaded artifact. Ex: projects/p1/locations/us/repositories/r1/packages/p1/versions/v1", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GoogleDevtoolsCloudbuildV1UploadedGoModule": { "description": "A Go module artifact uploaded to Artifact Registry using the GoModule directive.", "id": "GoogleDevtoolsCloudbuildV1UploadedGoModule", diff --git a/googleapiclient/discovery_cache/documents/saasservicemgmt.v1.json b/googleapiclient/discovery_cache/documents/saasservicemgmt.v1.json index afbe2ff9fc..1dd14a3aac 100644 --- a/googleapiclient/discovery_cache/documents/saasservicemgmt.v1.json +++ b/googleapiclient/discovery_cache/documents/saasservicemgmt.v1.json @@ -135,7 +135,7 @@ ] }, "list": { -"description": "Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.", +"description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "flatPath": "v1/projects/{projectsId}/locations", "httpMethod": "GET", "id": "saasservicemgmt.projects.locations.list", @@ -1804,7 +1804,7 @@ } } }, -"revision": "20260318", +"revision": "20260325", "rootUrl": "https://saasservicemgmt.googleapis.com/", "schemas": { "Aggregate": { @@ -2356,7 +2356,7 @@ "type": "string" }, "rolloutKind": { -"description": "Optional. Immutable. Name of the RolloutKind this rollout is stemming from and adhering to.", +"description": "Required. Immutable. Name of the RolloutKind this rollout is stemming from and adhering to.", "type": "string" }, "rolloutOrchestrationStrategy": { @@ -2584,12 +2584,25 @@ "description": "Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations", "type": "object" }, +"conditions": { +"description": "Output only. A set of conditions which indicate the various conditions this resource can have.", +"items": { +"$ref": "SaasCondition" +}, +"readOnly": true, +"type": "array" +}, "createTime": { "description": "Output only. The timestamp when the resource was created.", "format": "google-datetime", "readOnly": true, "type": "string" }, +"error": { +"$ref": "Status", +"description": "Output only. If the state is FAILED, the corresponding error code and message. Defaults to code=OK for all other states.", +"readOnly": true +}, "etag": { "description": "Output only. An opaque value that uniquely identifies a version or generation of a resource. It can be used to confirm that the client and server agree on the ordering of a resource being written.", "readOnly": true, @@ -2613,6 +2626,38 @@ "description": "Identifier. The resource name (full URI of the resource) following the standard naming scheme: \"projects/{project}/locations/{location}/saas/{saas}\"", "type": "string" }, +"state": { +"description": "Output only. State of the Saas. It is always in ACTIVE state if the application_template is empty.", +"enum": [ +"STATE_TYPE_UNSPECIFIED", +"ACTIVE", +"RUNNING", +"FAILED", +"STATE_ACTIVE", +"STATE_RUNNING", +"STATE_FAILED" +], +"enumDeprecated": [ +false, +true, +true, +true, +false, +false, +false +], +"enumDescriptions": [ +"State type is unspecified.", +"Deprecated: Use STATE_ACTIVE.", +"Deprecated: Use STATE_RUNNING.", +"Deprecated: Use STATE_FAILED.", +"The Saas is ready", +"In the process of importing, synchronizing or replicating ApplicationTemplates", +"Failure during process of importing, synchronizing or replicating ApplicationTemplate processing" +], +"readOnly": true, +"type": "string" +}, "uid": { "description": "Output only. The unique identifier of the resource. UID is unique in the time and space for this resource within the scope of the service. It is typically generated by the server on successful creation of a resource and must not be changed. UID is used to uniquely identify resources with resource name reuses. This should be a UUID4.", "readOnly": true, @@ -2627,6 +2672,56 @@ }, "type": "object" }, +"SaasCondition": { +"description": "SaasCondition describes the status of a Saas.", +"id": "SaasCondition", +"properties": { +"lastTransitionTime": { +"description": "Required. Last time the condition transited from one status to another.", +"format": "google-datetime", +"type": "string" +}, +"message": { +"description": "Required. Human readable message indicating details about the last transition.", +"type": "string" +}, +"reason": { +"description": "Required. Brief reason for the condition's last transition.", +"type": "string" +}, +"status": { +"description": "Required. Status of the condition.", +"enum": [ +"STATUS_UNSPECIFIED", +"STATUS_UNKNOWN", +"STATUS_TRUE", +"STATUS_FALSE" +], +"enumDescriptions": [ +"Condition status is unspecified.", +"Condition is unknown.", +"Condition is true.", +"Condition is false." +], +"type": "string" +}, +"type": { +"description": "Required. Type of the condition.", +"enum": [ +"TYPE_UNSPECIFIED", +"TYPE_READY", +"TYPE_SYNCHRONIZED" +], +"enumDescriptions": [ +"Condition type is unspecified.", +"Condition type is ready.", +"Condition type is synchronized." +], +"type": "string" +} +}, +"type": "object" +}, "Schedule": { "description": "A time specification to schedule the maintenance.", "id": "Schedule", @@ -2639,6 +2734,33 @@ }, "type": "object" }, +"Status": { +"description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", +"id": "Status", +"properties": { +"code": { +"description": "The status code, which should be an enum value of google.rpc.Code.", +"format": "int32", +"type": "integer" +}, +"details": { +"description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", +"items": { +"additionalProperties": { +"description": "Properties of the object. Contains field @type with type URL.", +"type": "any" +}, +"type": "object" +}, +"type": "array" +}, +"message": { +"description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", +"type": "string" +} +}, +"type": "object" +}, "Tenant": { "description": "Tenant represents the service producer side of an instance of the service created based on a request from a consumer. In a typical scenario a Tenant has a one-to-one mapping with a resource given out to a service consumer. Example: tenant: name: \"projects/svc1/locations/loc/tenants/inst-068afff8\" consumer_resource: \"projects/gshoe/locations/loc/shoes/black-shoe\"", "id": "Tenant", diff --git a/googleapiclient/discovery_cache/documents/saasservicemgmt.v1beta1.json b/googleapiclient/discovery_cache/documents/saasservicemgmt.v1beta1.json index b92748e25e..b78fbc28a2 100644 --- a/googleapiclient/discovery_cache/documents/saasservicemgmt.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/saasservicemgmt.v1beta1.json @@ -135,7 +135,7 @@ ] }, "list": { -"description": "Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.", +"description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "flatPath": "v1beta1/projects/{projectsId}/locations", "httpMethod": "GET", "id": "saasservicemgmt.projects.locations.list", @@ -1804,7 +1804,7 @@ } } }, -"revision": "20260318", +"revision": "20260325", "rootUrl": "https://saasservicemgmt.googleapis.com/", "schemas": { "Aggregate": { @@ -1823,6 +1823,21 @@ }, "type": "object" }, +"AppParams": { +"description": "AppParams contains the parameters for creating an AppHub Application.", +"id": "AppParams", +"properties": { +"group": { +"description": "Grouping used to construct the name of the AppHub Application. Multiple UnitKinds can specify the same group to use the same Application across their respective units. Corresponds to the app_boundary_id in the ADC composite ApplicationTemplate. Defaults to UnitKind.name", +"type": "string" +}, +"scope": { +"$ref": "Scope", +"description": "Corresponds to the scope in the ADC composite ApplicationTemplate. Defaults to REGIONAL." +} +}, +"type": "object" +}, "Blueprint": { "description": "Blueprints are OCI Images that contain all of the artifacts needed to provision a unit. Metadata such as, type of the engine used to actuate the blueprint (e.g. terraform, helm etc) and version will come from the image manifest. If the hostname is omitted, it will be assumed to be the regional path to Artifact Registry (eg. us-east1-docker.pkg.dev).", "id": "Blueprint", @@ -1844,6 +1859,45 @@ }, "type": "object" }, +"ComponentRef": { +"description": "ComponentRef represents a reference to a component resource. Next ID: 4", +"id": "ComponentRef", +"properties": { +"component": { +"description": "Name of the component in composite.Components", +"type": "string" +}, +"compositeRef": { +"$ref": "CompositeRef", +"description": "Reference to the Composite ApplicationTemplate." +}, +"revision": { +"description": "Revision of the component. If the component does not have a revision, this field will be explicitly set to the revision of the composite ApplicationTemplate.", +"type": "string" +} +}, +"type": "object" +}, +"CompositeRef": { +"description": "CompositeRef represents a reference to a composite resource. Next ID: 4", +"id": "CompositeRef", +"properties": { +"applicationTemplate": { +"description": "Required. Reference to the ApplicationTemplate resource.", +"type": "string" +}, +"revision": { +"description": "Revision of the ApplicationTemplate to use. Changes to revision will trigger manual resynchronization. If empty, ApplicationTemplate will be ignored.", +"type": "string" +}, +"syncOperation": { +"description": "Output only. Reference to on-going AppTemplate import and replication operation (i.e. the operation_id for the long-running operation). This field is opaque for external usage.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "Dependency": { "description": "Dependency represent a single dependency with another unit kind by alias.", "id": "Dependency", @@ -2207,6 +2261,11 @@ "description": "Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations", "type": "object" }, +"applicationTemplateComponent": { +"$ref": "ComponentRef", +"description": "Output only. Reference to component and revision in a composite ApplicationTemplate.", +"readOnly": true +}, "blueprint": { "$ref": "Blueprint", "description": "Optional. Blueprints are OCI Images that contain all of the artifacts needed to provision a unit." @@ -2356,7 +2415,7 @@ "type": "string" }, "rolloutKind": { -"description": "Optional. Immutable. Name of the RolloutKind this rollout is stemming from and adhering to.", +"description": "Required. Immutable. Name of the RolloutKind this rollout is stemming from and adhering to.", "type": "string" }, "rolloutOrchestrationStrategy": { @@ -2584,12 +2643,34 @@ "description": "Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations", "type": "object" }, +"applicationTemplate": { +"$ref": "CompositeRef", +"description": "Reference to composite ApplicationTemplate. When specified, the template components will be imported into their equivalent UnitKind, Release and Blueprint resources. Deleted references will not delete imported resources. Should only be specified on source regions, and be unspecified on replica regions." +}, +"blueprintRepo": { +"description": "Output only. Name of repository in Artifact Registry for system-generated Blueprints, eg. Blueprints of imported ApplicationTemplates.", +"readOnly": true, +"type": "string" +}, +"conditions": { +"description": "Output only. A set of conditions which indicate the various conditions this resource can have.", +"items": { +"$ref": "SaasCondition" +}, +"readOnly": true, +"type": "array" +}, "createTime": { "description": "Output only. The timestamp when the resource was created.", "format": "google-datetime", "readOnly": true, "type": "string" }, +"error": { +"$ref": "Status", +"description": "Output only. If the state is FAILED, the corresponding error code and message. Defaults to code=OK for all other states.", +"readOnly": true +}, "etag": { "description": "Output only. An opaque value that uniquely identifies a version or generation of a resource. It can be used to confirm that the client and server agree on the ordering of a resource being written.", "readOnly": true, @@ -2613,6 +2694,38 @@ "description": "Identifier. The resource name (full URI of the resource) following the standard naming scheme: \"projects/{project}/locations/{location}/saas/{saas}\"", "type": "string" }, +"state": { +"description": "Output only. State of the Saas. It is always in ACTIVE state if the application_template is empty.", +"enum": [ +"STATE_TYPE_UNSPECIFIED", +"ACTIVE", +"RUNNING", +"FAILED", +"STATE_ACTIVE", +"STATE_RUNNING", +"STATE_FAILED" +], +"enumDeprecated": [ +false, +true, +true, +true, +false, +false, +false +], +"enumDescriptions": [ +"State type is unspecified.", +"Deprecated: Use STATE_ACTIVE.", +"Deprecated: Use STATE_RUNNING.", +"Deprecated: Use STATE_FAILED.", +"The Saas is ready", +"In the process of importing, synchronizing or replicating ApplicationTemplates", +"Failure during process of importing, synchronizing or replicating ApplicationTemplate processing" +], +"readOnly": true, +"type": "string" +}, "uid": { "description": "Output only. The unique identifier of the resource. UID is unique in the time and space for this resource within the scope of the service. It is typically generated by the server on successful creation of a resource and must not be changed. UID is used to uniquely identify resources with resource name reuses. This should be a UUID4.", "readOnly": true, @@ -2627,6 +2740,56 @@ }, "type": "object" }, +"SaasCondition": { +"description": "SaasCondition describes the status of a Saas.", +"id": "SaasCondition", +"properties": { +"lastTransitionTime": { +"description": "Required. Last time the condition transited from one status to another.", +"format": "google-datetime", +"type": "string" +}, +"message": { +"description": "Required. Human readable message indicating details about the last transition.", +"type": "string" +}, +"reason": { +"description": "Required. Brief reason for the condition's last transition.", +"type": "string" +}, +"status": { +"description": "Required. Status of the condition.", +"enum": [ +"STATUS_UNSPECIFIED", +"STATUS_UNKNOWN", +"STATUS_TRUE", +"STATUS_FALSE" +], +"enumDescriptions": [ +"Condition status is unspecified.", +"Condition is unknown.", +"Condition is true.", +"Condition is false." +], +"type": "string" +}, +"type": { +"description": "Required. Type of the condition.", +"enum": [ +"TYPE_UNSPECIFIED", +"TYPE_READY", +"TYPE_SYNCHRONIZED" +], +"enumDescriptions": [ +"Condition type is unspecified.", +"Condition type is ready.", +"Condition type is synchronized." +], +"type": "string" +} +}, +"type": "object" +}, "Schedule": { "description": "A time specification to schedule the maintenance.", "id": "Schedule", @@ -2639,6 +2802,65 @@ }, "type": "object" }, +"Scope": { +"description": "Scope of an application.", +"id": "Scope", +"properties": { +"type": { +"description": "Required. Scope Type.", +"enum": [ +"TYPE_UNSPECIFIED", +"REGIONAL", +"GLOBAL", +"TYPE_REGIONAL", +"TYPE_GLOBAL" +], +"enumDeprecated": [ +false, +true, +true, +false, +false +], +"enumDescriptions": [ +"Unspecified type.", +"Deprecated: Use TYPE_REGIONAL.", +"Deprecated: Use TYPE_GLOBAL.", +"Regional type.", +"Global type." +], +"type": "string" +} +}, +"type": "object" +}, +"Status": { +"description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", +"id": "Status", +"properties": { +"code": { +"description": "The status code, which should be an enum value of google.rpc.Code.", +"format": "int32", +"type": "integer" +}, +"details": { +"description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", +"items": { +"additionalProperties": { +"description": "Properties of the object. Contains field @type with type URL.", +"type": "any" +}, +"type": "object" +}, +"type": "array" +}, +"message": { +"description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", +"type": "string" +} +}, +"type": "object" +}, "Tenant": { "description": "Tenant represents the service producer side of an instance of the service created based on a request from a consumer. In a typical scenario a Tenant has a one-to-one mapping with a resource given out to a service consumer. Example: tenant: name: \"projects/svc1/locations/loc/tenants/inst-068afff8\" consumer_resource: \"projects/gshoe/locations/loc/shoes/black-shoe\"", "id": "Tenant", @@ -2724,6 +2946,10 @@ "description": "Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations", "type": "object" }, +"application": { +"description": "Optional. Reference to the AppHub Application this unit belongs to. All resources deployed in this Unit will be associated with the specified Application.", +"type": "string" +}, "conditions": { "description": "Optional. Output only. A set of conditions which indicate the various conditions this resource can have.", "items": { @@ -2993,6 +3219,15 @@ "description": "Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations", "type": "object" }, +"appParams": { +"$ref": "AppParams", +"description": "AppParams contains the parameters for creating an AppHub Application." +}, +"applicationTemplateComponent": { +"$ref": "ComponentRef", +"description": "Output only. Reference to component and revision in a composite ApplicationTemplate.", +"readOnly": true +}, "createTime": { "description": "Output only. The timestamp when the resource was created.", "format": "google-datetime", diff --git a/googleapiclient/discovery_cache/documents/securitycenter.v1.json b/googleapiclient/discovery_cache/documents/securitycenter.v1.json index 8ade72b21d..c6e45d18c9 100644 --- a/googleapiclient/discovery_cache/documents/securitycenter.v1.json +++ b/googleapiclient/discovery_cache/documents/securitycenter.v1.json @@ -5944,7 +5944,7 @@ } } }, -"revision": "20260324", +"revision": "20260330", "rootUrl": "https://securitycenter.googleapis.com/", "schemas": { "Access": { @@ -7710,6 +7710,53 @@ false }, "type": "object" }, +"DiscoveredWorkload": { +"description": "Represents discovered, customer managed workload that is not registered with the respective GCP service.", +"id": "DiscoveredWorkload", +"properties": { +"confidence": { +"description": "The confidence in detection of this workload.", +"enum": [ +"CONFIDENCE_UNSPECIFIED", +"CONFIDENCE_HIGH" +], +"enumDescriptions": [ +"Unspecified confidence level.", +"High confidence in detection of a workload." +], +"type": "string" +}, +"detectedRelevantHardware": { +"description": "A boolean flag set to true if associated hardware strongly predicts the workload type.", +"type": "boolean" +}, +"detectedRelevantKeywords": { +"description": "A boolean flag set to true if associated keywords strongly predict the workload type.", +"type": "boolean" +}, +"detectedRelevantPackages": { +"description": "A boolean flag set to true if installed packages strongly predict the workload type.", +"type": "boolean" +}, +"workloadType": { +"description": "The type of workload.", +"enum": [ +"WORKLOAD_TYPE_UNSPECIFIED", +"MCP_SERVER", +"AI_INFERENCE", +"AGENT" +], +"enumDescriptions": [ +"Unspecified workload type", +"A workload of type MCP Server", +"A workload of type AI Inference", +"A workload of type LLM Agent" +], +"type": "string" +} +}, +"type": "object" +}, "Disk": { "description": "Contains information about the disk associated with the finding.", "id": "Disk", @@ -8278,6 +8325,10 @@ false "description": "Contains more details about the finding.", "type": "string" }, +"discoveredWorkload": { +"$ref": "DiscoveredWorkload", +"description": "DiscoveredWorkload associated with the finding." +}, "disk": { "$ref": "Disk", "description": "Disk associated with the finding." @@ -11173,6 +11224,53 @@ false }, "type": "object" }, +"GoogleCloudSecuritycenterV2DiscoveredWorkload": { +"description": "Represents discovered, customer managed workload that is not registered with the respective GCP service.", +"id": "GoogleCloudSecuritycenterV2DiscoveredWorkload", +"properties": { +"confidence": { +"description": "The confidence in detection of this workload.", +"enum": [ +"CONFIDENCE_UNSPECIFIED", +"CONFIDENCE_HIGH" +], +"enumDescriptions": [ +"Unspecified confidence level.", +"High confidence in detection of a workload." +], +"type": "string" +}, +"detectedRelevantHardware": { +"description": "A boolean flag set to true if associated hardware strongly predicts the workload type.", +"type": "boolean" +}, +"detectedRelevantKeywords": { +"description": "A boolean flag set to true if associated keywords strongly predict the workload type.", +"type": "boolean" +}, +"detectedRelevantPackages": { +"description": "A boolean flag set to true if installed packages strongly predict the workload type.", +"type": "boolean" +}, +"workloadType": { +"description": "The type of workload.", +"enum": [ +"WORKLOAD_TYPE_UNSPECIFIED", +"MCP_SERVER", +"AI_INFERENCE", +"AGENT" +], +"enumDescriptions": [ +"Unspecified workload type", +"A workload of type MCP Server", +"A workload of type AI Inference", +"A workload of type LLM Agent" +], +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudSecuritycenterV2Disk": { "description": "Contains information about the disk associated with the finding.", "id": "GoogleCloudSecuritycenterV2Disk", @@ -11609,6 +11707,10 @@ false "description": "Contains more details about the finding.", "type": "string" }, +"discoveredWorkload": { +"$ref": "GoogleCloudSecuritycenterV2DiscoveredWorkload", +"description": "DiscoveredWorkload associated with the finding." +}, "disk": { "$ref": "GoogleCloudSecuritycenterV2Disk", "description": "Disk associated with the finding." diff --git a/googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json b/googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json index b2fb65b2f0..b2e611534a 100644 --- a/googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json @@ -919,7 +919,7 @@ } } }, -"revision": "20260324", +"revision": "20260330", "rootUrl": "https://securitycenter.googleapis.com/", "schemas": { "Access": { @@ -2445,6 +2445,53 @@ false }, "type": "object" }, +"DiscoveredWorkload": { +"description": "Represents discovered, customer managed workload that is not registered with the respective GCP service.", +"id": "DiscoveredWorkload", +"properties": { +"confidence": { +"description": "The confidence in detection of this workload.", +"enum": [ +"CONFIDENCE_UNSPECIFIED", +"CONFIDENCE_HIGH" +], +"enumDescriptions": [ +"Unspecified confidence level.", +"High confidence in detection of a workload." +], +"type": "string" +}, +"detectedRelevantHardware": { +"description": "A boolean flag set to true if associated hardware strongly predicts the workload type.", +"type": "boolean" +}, +"detectedRelevantKeywords": { +"description": "A boolean flag set to true if associated keywords strongly predict the workload type.", +"type": "boolean" +}, +"detectedRelevantPackages": { +"description": "A boolean flag set to true if installed packages strongly predict the workload type.", +"type": "boolean" +}, +"workloadType": { +"description": "The type of workload.", +"enum": [ +"WORKLOAD_TYPE_UNSPECIFIED", +"MCP_SERVER", +"AI_INFERENCE", +"AGENT" +], +"enumDescriptions": [ +"Unspecified workload type", +"A workload of type MCP Server", +"A workload of type AI Inference", +"A workload of type LLM Agent" +], +"type": "string" +} +}, +"type": "object" +}, "Disk": { "description": "Contains information about the disk associated with the finding.", "id": "Disk", @@ -2867,6 +2914,10 @@ false "description": "Contains more details about the finding.", "type": "string" }, +"discoveredWorkload": { +"$ref": "DiscoveredWorkload", +"description": "DiscoveredWorkload associated with the finding." +}, "disk": { "$ref": "Disk", "description": "Disk associated with the finding." @@ -5843,6 +5894,53 @@ false }, "type": "object" }, +"GoogleCloudSecuritycenterV2DiscoveredWorkload": { +"description": "Represents discovered, customer managed workload that is not registered with the respective GCP service.", +"id": "GoogleCloudSecuritycenterV2DiscoveredWorkload", +"properties": { +"confidence": { +"description": "The confidence in detection of this workload.", +"enum": [ +"CONFIDENCE_UNSPECIFIED", +"CONFIDENCE_HIGH" +], +"enumDescriptions": [ +"Unspecified confidence level.", +"High confidence in detection of a workload." +], +"type": "string" +}, +"detectedRelevantHardware": { +"description": "A boolean flag set to true if associated hardware strongly predicts the workload type.", +"type": "boolean" +}, +"detectedRelevantKeywords": { +"description": "A boolean flag set to true if associated keywords strongly predict the workload type.", +"type": "boolean" +}, +"detectedRelevantPackages": { +"description": "A boolean flag set to true if installed packages strongly predict the workload type.", +"type": "boolean" +}, +"workloadType": { +"description": "The type of workload.", +"enum": [ +"WORKLOAD_TYPE_UNSPECIFIED", +"MCP_SERVER", +"AI_INFERENCE", +"AGENT" +], +"enumDescriptions": [ +"Unspecified workload type", +"A workload of type MCP Server", +"A workload of type AI Inference", +"A workload of type LLM Agent" +], +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudSecuritycenterV2Disk": { "description": "Contains information about the disk associated with the finding.", "id": "GoogleCloudSecuritycenterV2Disk", @@ -6279,6 +6377,10 @@ false "description": "Contains more details about the finding.", "type": "string" }, +"discoveredWorkload": { +"$ref": "GoogleCloudSecuritycenterV2DiscoveredWorkload", +"description": "DiscoveredWorkload associated with the finding." +}, "disk": { "$ref": "GoogleCloudSecuritycenterV2Disk", "description": "Disk associated with the finding." diff --git a/googleapiclient/discovery_cache/documents/securitycenter.v1beta2.json b/googleapiclient/discovery_cache/documents/securitycenter.v1beta2.json index 7a75af79b5..7cf5bd4505 100644 --- a/googleapiclient/discovery_cache/documents/securitycenter.v1beta2.json +++ b/googleapiclient/discovery_cache/documents/securitycenter.v1beta2.json @@ -2003,7 +2003,7 @@ } } }, -"revision": "20260324", +"revision": "20260330", "rootUrl": "https://securitycenter.googleapis.com/", "schemas": { "Access": { @@ -3502,6 +3502,53 @@ false }, "type": "object" }, +"DiscoveredWorkload": { +"description": "Represents discovered, customer managed workload that is not registered with the respective GCP service.", +"id": "DiscoveredWorkload", +"properties": { +"confidence": { +"description": "The confidence in detection of this workload.", +"enum": [ +"CONFIDENCE_UNSPECIFIED", +"CONFIDENCE_HIGH" +], +"enumDescriptions": [ +"Unspecified confidence level.", +"High confidence in detection of a workload." +], +"type": "string" +}, +"detectedRelevantHardware": { +"description": "A boolean flag set to true if associated hardware strongly predicts the workload type.", +"type": "boolean" +}, +"detectedRelevantKeywords": { +"description": "A boolean flag set to true if associated keywords strongly predict the workload type.", +"type": "boolean" +}, +"detectedRelevantPackages": { +"description": "A boolean flag set to true if installed packages strongly predict the workload type.", +"type": "boolean" +}, +"workloadType": { +"description": "The type of workload.", +"enum": [ +"WORKLOAD_TYPE_UNSPECIFIED", +"MCP_SERVER", +"AI_INFERENCE", +"AGENT" +], +"enumDescriptions": [ +"Unspecified workload type", +"A workload of type MCP Server", +"A workload of type AI Inference", +"A workload of type LLM Agent" +], +"type": "string" +} +}, +"type": "object" +}, "Disk": { "description": "Contains information about the disk associated with the finding.", "id": "Disk", @@ -3958,6 +4005,10 @@ false "description": "Contains more details about the finding.", "type": "string" }, +"discoveredWorkload": { +"$ref": "DiscoveredWorkload", +"description": "DiscoveredWorkload associated with the finding." +}, "disk": { "$ref": "Disk", "description": "Disk associated with the finding." @@ -6830,6 +6881,53 @@ false }, "type": "object" }, +"GoogleCloudSecuritycenterV2DiscoveredWorkload": { +"description": "Represents discovered, customer managed workload that is not registered with the respective GCP service.", +"id": "GoogleCloudSecuritycenterV2DiscoveredWorkload", +"properties": { +"confidence": { +"description": "The confidence in detection of this workload.", +"enum": [ +"CONFIDENCE_UNSPECIFIED", +"CONFIDENCE_HIGH" +], +"enumDescriptions": [ +"Unspecified confidence level.", +"High confidence in detection of a workload." +], +"type": "string" +}, +"detectedRelevantHardware": { +"description": "A boolean flag set to true if associated hardware strongly predicts the workload type.", +"type": "boolean" +}, +"detectedRelevantKeywords": { +"description": "A boolean flag set to true if associated keywords strongly predict the workload type.", +"type": "boolean" +}, +"detectedRelevantPackages": { +"description": "A boolean flag set to true if installed packages strongly predict the workload type.", +"type": "boolean" +}, +"workloadType": { +"description": "The type of workload.", +"enum": [ +"WORKLOAD_TYPE_UNSPECIFIED", +"MCP_SERVER", +"AI_INFERENCE", +"AGENT" +], +"enumDescriptions": [ +"Unspecified workload type", +"A workload of type MCP Server", +"A workload of type AI Inference", +"A workload of type LLM Agent" +], +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudSecuritycenterV2Disk": { "description": "Contains information about the disk associated with the finding.", "id": "GoogleCloudSecuritycenterV2Disk", @@ -7266,6 +7364,10 @@ false "description": "Contains more details about the finding.", "type": "string" }, +"discoveredWorkload": { +"$ref": "GoogleCloudSecuritycenterV2DiscoveredWorkload", +"description": "DiscoveredWorkload associated with the finding." +}, "disk": { "$ref": "GoogleCloudSecuritycenterV2Disk", "description": "Disk associated with the finding." diff --git a/googleapiclient/discovery_cache/documents/storagebatchoperations.v1.json b/googleapiclient/discovery_cache/documents/storagebatchoperations.v1.json index b864489670..12ea6e29be 100644 --- a/googleapiclient/discovery_cache/documents/storagebatchoperations.v1.json +++ b/googleapiclient/discovery_cache/documents/storagebatchoperations.v1.json @@ -135,7 +135,7 @@ ] }, "list": { -"description": "Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.", +"description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "flatPath": "v1/projects/{projectsId}/locations", "httpMethod": "GET", "id": "storagebatchoperations.projects.locations.list", @@ -569,7 +569,7 @@ } } }, -"revision": "20260218", +"revision": "20260325", "rootUrl": "https://storagebatchoperations.googleapis.com/", "schemas": { "Bucket": { @@ -728,7 +728,25 @@ "id": "Counters", "properties": { "failedObjectCount": { -"description": "Output only. Number of objects failed.", +"description": "Output only. The number of objects that failed due to user errors or service errors.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"objectCustomContextsCreated": { +"description": "Output only. Number of object custom contexts created. This field is only populated for jobs with the UpdateObjectCustomContext transformation.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"objectCustomContextsDeleted": { +"description": "Output only. Number of object custom contexts deleted. This field is only populated for jobs with the UpdateObjectCustomContext transformation.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"objectCustomContextsUpdated": { +"description": "Output only. Number of object custom contexts updated. This counter tracks custom contexts where the key already existed, but the payload was modified. This field is only populated for jobs with the UpdateObjectCustomContext transformation.", "format": "int64", "readOnly": true, "type": "string" diff --git a/googleapiclient/discovery_cache/documents/workflows.v1.json b/googleapiclient/discovery_cache/documents/workflows.v1.json index bc5f00e694..db817defed 100644 --- a/googleapiclient/discovery_cache/documents/workflows.v1.json +++ b/googleapiclient/discovery_cache/documents/workflows.v1.json @@ -135,7 +135,7 @@ ] }, "list": { -"description": "Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.", +"description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "flatPath": "v1/projects/{projectsId}/locations", "httpMethod": "GET", "id": "workflows.projects.locations.list", @@ -496,7 +496,7 @@ } } }, -"revision": "20260128", +"revision": "20260322", "rootUrl": "https://workflows.googleapis.com/", "schemas": { "Empty": { diff --git a/googleapiclient/discovery_cache/documents/workflows.v1beta.json b/googleapiclient/discovery_cache/documents/workflows.v1beta.json index 1903bdfad1..d4d9d5b678 100644 --- a/googleapiclient/discovery_cache/documents/workflows.v1beta.json +++ b/googleapiclient/discovery_cache/documents/workflows.v1beta.json @@ -135,7 +135,7 @@ ] }, "list": { -"description": "Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.", +"description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "flatPath": "v1beta/projects/{projectsId}/locations", "httpMethod": "GET", "id": "workflows.projects.locations.list", @@ -455,7 +455,7 @@ } } }, -"revision": "20260128", +"revision": "20260322", "rootUrl": "https://workflows.googleapis.com/", "schemas": { "Empty": { diff --git a/googleapiclient/discovery_cache/documents/workspaceevents.v1.json b/googleapiclient/discovery_cache/documents/workspaceevents.v1.json index df19e97a11..18a358a35b 100644 --- a/googleapiclient/discovery_cache/documents/workspaceevents.v1.json +++ b/googleapiclient/discovery_cache/documents/workspaceevents.v1.json @@ -5,12 +5,18 @@ "https://www.googleapis.com/auth/chat.app.memberships": { "description": "On their own behalf, apps in Google Chat can see, add, update, and remove members from conversations and spaces" }, +"https://www.googleapis.com/auth/chat.app.memberships.readonly": { +"description": "On their own behalf, apps in Google Chat can see members of conversations and spaces" +}, "https://www.googleapis.com/auth/chat.app.messages.readonly": { "description": "On their own behalf, apps in Google Chat can see all messages and their associated reactions and message content" }, "https://www.googleapis.com/auth/chat.app.spaces": { "description": "On their own behalf, apps in Google Chat can create conversations and spaces and see or update their metadata (including history settings and access settings)" }, +"https://www.googleapis.com/auth/chat.app.spaces.readonly": { +"description": "On their own behalf, apps in Google Chat can see conversations and spaces and their metadata (including history settings and access settings)" +}, "https://www.googleapis.com/auth/chat.bot": { "description": "Private Service: https://www.googleapis.com/auth/chat.bot" }, @@ -246,8 +252,10 @@ }, "scopes": [ "https://www.googleapis.com/auth/chat.app.memberships", +"https://www.googleapis.com/auth/chat.app.memberships.readonly", "https://www.googleapis.com/auth/chat.app.messages.readonly", "https://www.googleapis.com/auth/chat.app.spaces", +"https://www.googleapis.com/auth/chat.app.spaces.readonly", "https://www.googleapis.com/auth/chat.memberships", "https://www.googleapis.com/auth/chat.memberships.readonly", "https://www.googleapis.com/auth/chat.messages", @@ -444,8 +452,10 @@ }, "scopes": [ "https://www.googleapis.com/auth/chat.app.memberships", +"https://www.googleapis.com/auth/chat.app.memberships.readonly", "https://www.googleapis.com/auth/chat.app.messages.readonly", "https://www.googleapis.com/auth/chat.app.spaces", +"https://www.googleapis.com/auth/chat.app.spaces.readonly", "https://www.googleapis.com/auth/chat.memberships", "https://www.googleapis.com/auth/chat.memberships.readonly", "https://www.googleapis.com/auth/chat.messages", @@ -489,8 +499,10 @@ }, "scopes": [ "https://www.googleapis.com/auth/chat.app.memberships", +"https://www.googleapis.com/auth/chat.app.memberships.readonly", "https://www.googleapis.com/auth/chat.app.messages.readonly", "https://www.googleapis.com/auth/chat.app.spaces", +"https://www.googleapis.com/auth/chat.app.spaces.readonly", "https://www.googleapis.com/auth/chat.memberships", "https://www.googleapis.com/auth/chat.memberships.readonly", "https://www.googleapis.com/auth/chat.messages", @@ -733,7 +745,7 @@ } } }, -"revision": "20251216", +"revision": "20260329", "rootUrl": "https://workspaceevents.googleapis.com/", "schemas": { "Artifact": { @@ -1198,6 +1210,11 @@ "readOnly": true, "type": "boolean" }, +"serviceAccountAuthority": { +"description": "Output only. The service account that was used to authorize the creation of the subscription. This service account must be owned by the same Google Cloud project where you create this subscription. Format: `projects/{project_id}/serviceAccounts/{service_account_id}` [Developer Preview](https://developers.google.com/workspace/preview).", +"readOnly": true, +"type": "string" +}, "state": { "description": "Output only. The state of the subscription. Determines whether the subscription can receive events and deliver them to the notification endpoint.", "enum": [ @@ -1220,8 +1237,10 @@ "enum": [ "ERROR_TYPE_UNSPECIFIED", "USER_SCOPE_REVOKED", +"APP_SCOPE_REVOKED", "RESOURCE_DELETED", "USER_AUTHORIZATION_FAILURE", +"APP_AUTHORIZATION_FAILURE", "ENDPOINT_PERMISSION_DENIED", "ENDPOINT_NOT_FOUND", "ENDPOINT_RESOURCE_EXHAUSTED", @@ -1230,8 +1249,10 @@ "enumDescriptions": [ "Default value. This value is unused.", "The authorizing user has revoked the grant of one or more OAuth scopes. To learn more about authorization for Google Workspace, see [Configure the OAuth consent screen](https://developers.google.com/workspace/guides/configure-oauth-consent#choose-scopes).", +"The domain administrator has revoked the grant of one or more OAuth scopes for the app. [Developer Preview](https://developers.google.com/workspace/preview).", "The target resource for the subscription no longer exists.", "The user that authorized the creation of the subscription no longer has access to the subscription's target resource.", +"The app that authorized the creation of the subscription no longer has access to the subscription's target resource. [Developer Preview](https://developers.google.com/workspace/preview).", "The Google Workspace application doesn't have access to deliver events to your subscription's notification endpoint.", "The subscription's notification endpoint doesn't exist, or the endpoint can't be found in the Google Cloud project where you created the subscription.", "The subscription's notification endpoint failed to receive events due to insufficient quota or reaching rate limiting.", @@ -1259,6 +1280,11 @@ "format": "google-datetime", "readOnly": true, "type": "string" +}, +"userAuthority": { +"description": "Output only. The user who authorized the creation of the subscription. The user must be able to view the `target_resource`. For Google Workspace users, the `{user}` value is the [`user.id`](https://developers.google.com/workspace/admin/directory/reference/rest/v1/users#User.FIELDS.id) field from the Directory API. Format: `users/{user}` [Developer Preview](https://developers.google.com/workspace/preview).", +"readOnly": true, +"type": "string" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/workstations.v1.json b/googleapiclient/discovery_cache/documents/workstations.v1.json index b04b6aa3c9..de1f6f27f0 100644 --- a/googleapiclient/discovery_cache/documents/workstations.v1.json +++ b/googleapiclient/discovery_cache/documents/workstations.v1.json @@ -135,7 +135,7 @@ ] }, "list": { -"description": "Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.", +"description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "flatPath": "v1/projects/{projectsId}/locations", "httpMethod": "GET", "id": "workstations.projects.locations.list", @@ -330,7 +330,7 @@ "type": "string" }, "validateOnly": { -"description": "Optional. If set, validate the request and preview the review, but do not actually apply it.", +"description": "Optional. If set, validate the request and preview the result, but do not actually apply it.", "location": "query", "type": "boolean" }, @@ -378,7 +378,7 @@ "type": "string" }, "validateOnly": { -"description": "Optional. If set, validate the request and preview the review, but do not apply it.", +"description": "Optional. If set, validate the request and preview the result, but do not apply it.", "location": "query", "type": "boolean" } @@ -485,7 +485,7 @@ "type": "string" }, "validateOnly": { -"description": "Optional. If set, validate the request and preview the review, but do not actually apply it.", +"description": "Optional. If set, validate the request and preview the result, but do not actually apply it.", "location": "query", "type": "boolean" } @@ -522,7 +522,7 @@ "type": "string" }, "validateOnly": { -"description": "Optional. If set, validate the request and preview the review, but do not actually apply it.", +"description": "Optional. If set, validate the request and preview the result, but do not actually apply it.", "location": "query", "type": "boolean" }, @@ -570,7 +570,7 @@ "type": "string" }, "validateOnly": { -"description": "Optional. If set, validate the request and preview the review, but do not actually apply it.", +"description": "Optional. If set, validate the request and preview the result, but do not actually apply it.", "location": "query", "type": "boolean" } @@ -744,7 +744,7 @@ "type": "string" }, "validateOnly": { -"description": "Optional. If set, validate the request and preview the review, but do not actually apply it.", +"description": "Optional. If set, validate the request and preview the result, but do not actually apply it.", "location": "query", "type": "boolean" } @@ -837,7 +837,7 @@ "type": "string" }, "validateOnly": { -"description": "Optional. If set, validate the request and preview the review, but do not actually apply it.", +"description": "Optional. If set, validate the request and preview the result, but do not actually apply it.", "location": "query", "type": "boolean" }, @@ -880,7 +880,7 @@ "type": "string" }, "validateOnly": { -"description": "Optional. If set, validate the request and preview the review, but do not actually apply it.", +"description": "Optional. If set, validate the request and preview the result, but do not actually apply it.", "location": "query", "type": "boolean" } @@ -1064,7 +1064,7 @@ ], "parameters": { "allowMissing": { -"description": "Optional. If set and the workstation configuration is not found, a new workstation configuration is created. In this situation, update_mask is ignored.", +"description": "Optional. If set and the workstation is not found, a new workstation is created. In this situation, update_mask is ignored.", "location": "query", "type": "boolean" }, @@ -1076,13 +1076,13 @@ "type": "string" }, "updateMask": { -"description": "Required. Mask specifying which fields in the workstation configuration should be updated.", +"description": "Required. Mask specifying which fields in the workstation should be updated.", "format": "google-fieldmask", "location": "query", "type": "string" }, "validateOnly": { -"description": "Optional. If set, validate the request and preview the review, but do not actually apply it.", +"description": "Optional. If set, validate the request and preview the result, but do not actually apply it.", "location": "query", "type": "boolean" } @@ -1221,7 +1221,7 @@ } } }, -"revision": "20260126", +"revision": "20260325", "rootUrl": "https://workstations.googleapis.com/", "schemas": { "Accelerator": { @@ -2200,7 +2200,7 @@ "type": "string" }, "validateOnly": { -"description": "Optional. If set, validate the request and preview the review, but do not actually apply it.", +"description": "Optional. If set, validate the request and preview the result, but do not actually apply it.", "type": "boolean" } }, @@ -2242,7 +2242,7 @@ "type": "string" }, "validateOnly": { -"description": "Optional. If set, validate the request and preview the review, but do not actually apply it.", +"description": "Optional. If set, validate the request and preview the result, but do not actually apply it.", "type": "boolean" } }, @@ -2362,14 +2362,18 @@ "STATE_STARTING", "STATE_RUNNING", "STATE_STOPPING", -"STATE_STOPPED" +"STATE_STOPPED", +"STATE_SUSPENDING", +"STATE_SUSPENDED" ], "enumDescriptions": [ "Do not use.", "The workstation is not yet ready to accept requests from users but will be soon.", "The workstation is ready to accept requests from users.", "The workstation is being stopped.", -"The workstation is stopped and will not be able to receive requests until it is started." +"The workstation is stopped and will not be able to receive requests until it is started.", +"The workstation is being suspended.", +"The workstation is suspended." ], "readOnly": true, "type": "string" @@ -2624,7 +2628,7 @@ "type": "array" }, "runningTimeout": { -"description": "Optional. Number of seconds that a workstation can run until it is automatically shut down. We recommend that workstations be shut down daily to reduce costs and so that security updates can be applied upon restart. The idle_timeout and running_timeout fields are independent of each other. Note that the running_timeout field shuts down VMs after the specified time, regardless of whether or not the VMs are idle. Provide duration terminated by `s` for seconds\u2014for example, `\"54000s\"` (15 hours). Defaults to `\"43200s\"` (12 hours). A value of `\"0s\"` indicates that workstations using this configuration should never time out. If encryption_key is set, it must be greater than `\"0s\"` and less than `\"86400s\"` (24 hours). Warning: A value of `\"0s\"` indicates that Cloud Workstations VMs created with this configuration have no maximum running time. This is strongly discouraged because you incur costs and will not pick up security updates.", +"description": "Optional. Number of seconds that a workstation can run until it is automatically shut down. This field applies to workstations in both STATE_RUNNING and STATE_SUSPENDED. We recommend that workstations be shut down daily to reduce costs and so that security updates can be applied upon restart. The idle_timeout and running_timeout fields are independent of each other. Note that the running_timeout field shuts down VMs after the specified time, regardless of whether or not the VMs are idle. Provide duration terminated by `s` for seconds\u2014for example, `\"54000s\"` (15 hours). Defaults to `\"43200s\"` (12 hours). A value of `\"0s\"` indicates that workstations using this configuration should never time out. If encryption_key is set, it must be greater than `\"0s\"` and less than `\"86400s\"` (24 hours). Warning: A value of `\"0s\"` indicates that Cloud Workstations VMs created with this configuration have no maximum running time. This is strongly discouraged because you incur costs and will not pick up security updates.", "format": "google-duration", "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/workstations.v1beta.json b/googleapiclient/discovery_cache/documents/workstations.v1beta.json index a5f1663c05..43cc44db73 100644 --- a/googleapiclient/discovery_cache/documents/workstations.v1beta.json +++ b/googleapiclient/discovery_cache/documents/workstations.v1beta.json @@ -256,7 +256,7 @@ "type": "string" }, "validateOnly": { -"description": "Optional. If set, validate the request and preview the review, but do not actually apply it.", +"description": "Optional. If set, validate the request and preview the result, but do not actually apply it.", "location": "query", "type": "boolean" }, @@ -304,7 +304,7 @@ "type": "string" }, "validateOnly": { -"description": "Optional. If set, validate the request and preview the review, but do not apply it.", +"description": "Optional. If set, validate the request and preview the result, but do not apply it.", "location": "query", "type": "boolean" } @@ -411,7 +411,7 @@ "type": "string" }, "validateOnly": { -"description": "Optional. If set, validate the request and preview the review, but do not actually apply it.", +"description": "Optional. If set, validate the request and preview the result, but do not actually apply it.", "location": "query", "type": "boolean" } @@ -448,7 +448,7 @@ "type": "string" }, "validateOnly": { -"description": "Optional. If set, validate the request and preview the review, but do not actually apply it.", +"description": "Optional. If set, validate the request and preview the result, but do not actually apply it.", "location": "query", "type": "boolean" }, @@ -496,7 +496,7 @@ "type": "string" }, "validateOnly": { -"description": "Optional. If set, validate the request and preview the review, but do not actually apply it.", +"description": "Optional. If set, validate the request and preview the result, but do not actually apply it.", "location": "query", "type": "boolean" } @@ -670,7 +670,7 @@ "type": "string" }, "validateOnly": { -"description": "Optional. If set, validate the request and preview the review, but do not actually apply it.", +"description": "Optional. If set, validate the request and preview the result, but do not actually apply it.", "location": "query", "type": "boolean" } @@ -763,7 +763,7 @@ "type": "string" }, "validateOnly": { -"description": "Optional. If set, validate the request and preview the review, but do not actually apply it.", +"description": "Optional. If set, validate the request and preview the result, but do not actually apply it.", "location": "query", "type": "boolean" }, @@ -806,7 +806,7 @@ "type": "string" }, "validateOnly": { -"description": "Optional. If set, validate the request and preview the review, but do not actually apply it.", +"description": "Optional. If set, validate the request and preview the result, but do not actually apply it.", "location": "query", "type": "boolean" } @@ -990,7 +990,7 @@ ], "parameters": { "allowMissing": { -"description": "Optional. If set and the workstation configuration is not found, a new workstation configuration is created. In this situation, update_mask is ignored.", +"description": "Optional. If set and the workstation is not found, a new workstation is created. In this situation, update_mask is ignored.", "location": "query", "type": "boolean" }, @@ -1002,13 +1002,13 @@ "type": "string" }, "updateMask": { -"description": "Required. Mask specifying which fields in the workstation configuration should be updated.", +"description": "Required. Mask specifying which fields in the workstation should be updated.", "format": "google-fieldmask", "location": "query", "type": "string" }, "validateOnly": { -"description": "Optional. If set, validate the request and preview the review, but do not actually apply it.", +"description": "Optional. If set, validate the request and preview the result, but do not actually apply it.", "location": "query", "type": "boolean" } @@ -1147,7 +1147,7 @@ } } }, -"revision": "20260113", +"revision": "20260325", "rootUrl": "https://workstations.googleapis.com/", "schemas": { "Accelerator": { @@ -2136,7 +2136,7 @@ "type": "string" }, "validateOnly": { -"description": "Optional. If set, validate the request and preview the review, but do not actually apply it.", +"description": "Optional. If set, validate the request and preview the result, but do not actually apply it.", "type": "boolean" } }, @@ -2178,7 +2178,7 @@ "type": "string" }, "validateOnly": { -"description": "Optional. If set, validate the request and preview the review, but do not actually apply it.", +"description": "Optional. If set, validate the request and preview the result, but do not actually apply it.", "type": "boolean" } }, @@ -2329,14 +2329,18 @@ "STATE_STARTING", "STATE_RUNNING", "STATE_STOPPING", -"STATE_STOPPED" +"STATE_STOPPED", +"STATE_SUSPENDING", +"STATE_SUSPENDED" ], "enumDescriptions": [ "Do not use.", "The workstation is not yet ready to accept requests from users but will be soon.", "The workstation is ready to accept requests from users.", "The workstation is being stopped.", -"The workstation is stopped and will not be able to receive requests until it is started." +"The workstation is stopped and will not be able to receive requests until it is started.", +"The workstation is being suspended.", +"The workstation is suspended." ], "readOnly": true, "type": "string" @@ -2484,6 +2488,14 @@ "format": "google-datetime", "readOnly": true, "type": "string" +}, +"workstationAuthorizationUrl": { +"description": "Optional. Specifies the redirect URL for unauthorized requests received by workstation VMs in this cluster. Redirects to this endpoint will send a base64 encoded `state` query param containing the target workstation name and original request hostname. The endpoint is responsible for retrieving a token using `GenerateAccessToken` and redirecting back to the original hostname with the token.", +"type": "string" +}, +"workstationLaunchUrl": { +"description": "Optional. Specifies the launch URL for workstations in this cluster. Requests sent to unstarted workstations will be redirected to this URL. Requests redirected to the launch endpoint will be sent with a `workstation` and `project` query parameter containing the full workstation resource name and project ID, respectively. The launch endpoint is responsible for starting the workstation, polling it until it reaches `STATE_RUNNING`, and then issuing a redirect to the workstation's host URL.", +"type": "string" } }, "type": "object" @@ -2622,7 +2634,7 @@ "type": "array" }, "runningTimeout": { -"description": "Optional. Number of seconds that a workstation can run until it is automatically shut down. We recommend that workstations be shut down daily to reduce costs and so that security updates can be applied upon restart. The idle_timeout and running_timeout fields are independent of each other. Note that the running_timeout field shuts down VMs after the specified time, regardless of whether or not the VMs are idle. Provide duration terminated by `s` for seconds\u2014for example, `\"54000s\"` (15 hours). Defaults to `\"43200s\"` (12 hours). A value of `\"0s\"` indicates that workstations using this configuration should never time out. If encryption_key is set, it must be greater than `\"0s\"` and less than `\"86400s\"` (24 hours). Warning: A value of `\"0s\"` indicates that Cloud Workstations VMs created with this configuration have no maximum running time. This is strongly discouraged because you incur costs and will not pick up security updates.", +"description": "Optional. Number of seconds that a workstation can run until it is automatically shut down. This field applies to workstations in both STATE_RUNNING and STATE_SUSPENDED. We recommend that workstations be shut down daily to reduce costs and so that security updates can be applied upon restart. The idle_timeout and running_timeout fields are independent of each other. Note that the running_timeout field shuts down VMs after the specified time, regardless of whether or not the VMs are idle. Provide duration terminated by `s` for seconds\u2014for example, `\"54000s\"` (15 hours). Defaults to `\"43200s\"` (12 hours). A value of `\"0s\"` indicates that workstations using this configuration should never time out. If encryption_key is set, it must be greater than `\"0s\"` and less than `\"86400s\"` (24 hours). Warning: A value of `\"0s\"` indicates that Cloud Workstations VMs created with this configuration have no maximum running time. This is strongly discouraged because you incur costs and will not pick up security updates.", "format": "google-duration", "type": "string" },